DatabaseAbstractionLayerComponent

Type Members

1. case class BuildDatabaseStructure(objectsType: ContainerType) extends Product with Serializable

   

   Builds the the database structure.

   Builds the the database structure.

   Note: An empty database is expected.

   objectsType

   denotes which database/table to be created

   returns

   Future[Boolean] - true, if the operation was successful

2. case class ClearDatabaseStructure(objectsType: ContainerType) extends Product with Serializable

   

   Clears the database structure.

   Clears the database structure.

   Note: All data, tables, databases, etc, are destroyed.

   objectsType

   denotes which database/table to be removed

   returns

   Future[Boolean] - true, if the operation was successful

3. case class CreateObject(container: Container) extends Product with Serializable

   

   Creates a new entry for the supplied object in the database.

   Creates a new entry for the supplied object in the database.

   container

   the object data

   returns

   Future[Boolean] - true, if the operation was successful

4. case class DeleteObject(objectType: ContainerType, objectID: ObjectID) extends Product with Serializable

   

   Deletes the specified object form the database.

   Deletes the specified object form the database.

   objectType

   the type of the object to be deleted

   objectID

   the ID of the object

   returns

   Future[Boolean] - true, if the operation was successful

5. case class GetCustomQueryResult(objectsType: ContainerType, customQueryName: String, queryParams: Map[String, String]) extends Product with Serializable

   

   Performs a custom database query.

   Performs a custom database query.

   objectsType

   the type of objects to be queried

   customQueryName

   the custom query name to be performed

   queryParams

   the query parameters

   returns

   Future[ContainerSet] - a container set based on the query results

6. case class GetDatabaseIdentifier() extends Product with Serializable

   

   Retrieves a database identification string, for information/debugging purposes.

   Retrieves a database identification string, for information/debugging purposes.

   returns

   Future[String] - the identifier string

7. case class GetGenericQueryResult(objectsType: ContainerType) extends Product with Serializable

   

   Performs a generic database query that retrieves all data in for the specified container type.

   Performs a generic database query that retrieves all data in for the specified container type.

   objectsType

   the type of objects to be queried

   returns

   Future[ContainerSet] - a container set based on the query results

8. case class GetLayerType() extends Product with Serializable

   

   Retrieves the type of the Database Abstraction Layer.

   Retrieves the type of the Database Abstraction Layer.

   returns

   Future[LayerType] - the layer type

9. case class GetObject(objectType: ContainerType, objectID: ObjectID) extends Product with Serializable

   

   Retrieves the specified object.

   Retrieves the specified object.

   objectType

   the type of the object to be retrieved

   objectID

   the ID of the object to be retrieved

   returns

   Future[Container] - the requested object

10. case class GetSupportedContainers() extends Product with Serializable

    

    Retrieves a list of containers supported by the database.

    Retrieves a list of containers supported by the database.

    returns

    Future[ Vector[ContainerType] ] - the list of supported containers

11. case class LoadView(view: ContainerView) extends Product with Serializable

    

    Performs all queries defined in the supplied view and loads the resulting data in it.

    Performs all queries defined in the supplied view and loads the resulting data in it.

    view

    the view to load

    returns

    Future[Unit] - nothing (the supplied object is updated)

12. case class UpdateObject(container: MutableContainer) extends Product with Serializable

    

    Updates the existing entry for the supplied object in the database.

    Updates the existing entry for the supplied object in the database.

    Note: Immutable containers cannot be updated.

    container

    the object data

    returns

    Future[Boolean] - true, if the operation was successful

13. case class VerifyDatabaseStructure(objectsType: ContainerType) extends Product with Serializable

    

    Verifies the structure of the database.

    Verifies the structure of the database.

    objectsType

    denotes which database/table to be verified

    returns

    Future[Boolean] - true, if the structure is valid