Package de.fraunhofer.iosb.ilt.frostclient.dao

Interface Dao

All Known Implementing Classes:

BaseDao

public interface Dao

CRUD operations for Entity Types.

Method Summary

Modifier and Type	Method	Description
void	create(Entity entity)	Create a new entity.
void	delete(Entity entity)	Delete an entity.
Entity	find(Entity parent, NavigationPropertyEntity npe)	Find the entity related to the given parent, like the Thing for a Datastream.
Entity	find(Object... primaryKeyValues)	Find an entity.
Entity	find(URI uri)	Find an entity.
void	patch(Entity entity, List<com.github.fge.jsonpatch.JsonPatchOperation> patch)	Update the given entity with the given patch.
Query	query()	Start a query to find an entity collection.
void	update(Entity entity)	Update an entity.

Method Details

create

void create(Entity entity)
     throws ServiceFailureException

Create a new entity.

Parameters:

entity - the entity to create

Throws:

ServiceFailureException - the operation failed

find

Entity find(Object... primaryKeyValues)
     throws ServiceFailureException

Find an entity.

Parameters:

primaryKeyValues - the values for the entity's unique id

Returns:

the entity

Throws:

ServiceFailureException - the operation failed

find

Entity find(Entity parent,
 NavigationPropertyEntity npe)
     throws ServiceFailureException

Find the entity related to the given parent, like the Thing for a Datastream.

Parameters:

parent - The parent to find the singular entity for.

npe - The navigation property to load.

Returns:

the singular entity linked from the parent.

Throws:

ServiceFailureException - the operation failed

find

Entity find(URI uri)
     throws ServiceFailureException

Find an entity.

Parameters:

uri - the entity's URI

Returns:

the entity

Throws:

ServiceFailureException - the operation failed

update

void update(Entity entity)
     throws ServiceFailureException

Update an entity.

Parameters:

entity - the entity to update

Throws:

ServiceFailureException - the operation failed

patch

void patch(Entity entity,
 List<com.github.fge.jsonpatch.JsonPatchOperation> patch)
    throws ServiceFailureException

Update the given entity with the given patch. Does not update the entity object itself. To see the result, fetch it anew from the server.

Parameters:

entity - The entity to update on the server.

patch - The patch to apply to the entity.

Throws:

ServiceFailureException - the operation failed

delete

void delete(Entity entity)
     throws ServiceFailureException

Delete an entity.

Parameters:

entity - the entity to delete

Throws:

ServiceFailureException - the operation failed

query

Query query()

Start a query to find an entity collection.

Returns:

the query