com.edorasware.commons.core.service.entity

Interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

All Superinterfaces:

Service

All Known Subinterfaces:

AnyWorkObjectDefinitionService, AnyWorkObjectService, BeatService, DomainObjectDefinitionService<T,P,E,Q>, DomainObjectService<T,D,P,E,Q,W,WB,U,UB>, WorkObjectDefinitionService<T,P,E,Q>, WorkObjectService<T,D,P,E,Q,W,WB,U,UB>

All Known Implementing Classes:

BaseDomainObjectDefinitionService, BaseDomainObjectService, BaseEntityService, BaseWorkObjectDefinitionService, BaseWorkObjectService

public interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>
extends Service

Provides generic access to an entity service.

Method Summary

Modifier and Type	Method and Description
T	addEntity(E entity, String description) Adds the given ad-hoc entity.
GlobalId	addEntityGeneric(E entity, String description) Adds the given ad-hoc work entity and returns the persisted global id.
long	countEntities(Predicate predicate) Counts the entities that match the query with the given predicate.
long	countEntities(Predicate predicate, SearchScope searchScope) Counts the entities that match the query with the given predicate in the given scope.
long	countEntities(Q entityQuery) Counts the entities that match the given query.
long	countEntities(Q entityQuery, SearchScope searchScope) Counts the entities that match the given query in the given scope.
List<E>	findEntities(Predicate predicate) Finds the entities that match the query with the given predicate.
List<E>	findEntities(Predicate predicate, SearchScope searchScope) Finds the entities that match the query with the given predicate in the given scope.
List<E>	findEntities(Q entityQuery) Finds the entities that match the given query.
List<E>	findEntities(Q entityQuery, SearchScope searchScope) Finds the entities that match the given query in the given scope.
E	findEntity(Predicate predicate) Finds the entity that matches the query with the given predicate.
E	findEntity(Predicate predicate, SearchScope searchScope) Finds the entity that matches the query with the given predicate in the given scope.
E	findEntity(Q entityQuery) Finds the entity that matches the given query.
E	findEntity(Q entityQuery, SearchScope searchScope) Finds the entity that matches the given query in the given scope.
E	findEntityByExternalId(T externalId) Finds the entity with the given external entity id.
E	findEntityByExternalId(T externalId, SearchScope searchScope) Finds the entity with the given external entity id in the given scope.
E	findEntityByGlobalId(GlobalId globalId) Finds the entity with the given global id.
E	findEntityByGlobalId(GlobalId globalId, SearchScope searchScope) Finds the entity with the given entity global id in the given scope.
E	findEntityById(T id) Finds the entity with the given entity id.
E	findEntityById(T id, SearchScope searchScope) Finds the entity with the given entity id in the given scope.
T	findExternalIdByGlobalId(GlobalId globalId) Returns the external id of the entity with the given id.
T	findExternalIdByGlobalId(GlobalId globalId, SearchScope searchScope) Returns the external id of the entity with the given id in the given scope.
T	findExternalIdById(T id) Returns the external id of the entity with the given id.
T	findExternalIdById(T id, SearchScope searchScope) Returns the external id of the entity with the given id in the given scope.
GlobalId	findGlobalIdByExternalId(T externalId) Returns the global id of the entity with the given external id in the given scope.
GlobalId	findGlobalIdByExternalId(T externalId, SearchScope searchScope) Returns the global id of the entity with the given external id in the given scope.
T	findIdByExternalId(T externalId) Returns the id of the entity with the given external id.
T	findIdByExternalId(T externalId, SearchScope searchScope) Returns the id of the entity with the given external id in the given scope.
E	getEntityByGlobalId(GlobalId globalId) Finds the entity with the given entity id.
E	getEntityByGlobalId(GlobalId globalId, SearchScope searchScope) Finds the entity with the given entity id in the given scope.
E	getEntityById(T entityId) Finds the entity with the given entity id.
E	getEntityById(T entityId, SearchScope searchScope) Finds the entity with the given entity id in the given scope.

Methods inherited from interface com.edorasware.commons.core.util.service.Service

init

Method Detail

findExternalIdById

T findExternalIdById(T id)

Returns the external id of the entity with the given id.

Parameters:

id - the id of the entity

Returns:

the external id of the entity

findExternalIdById

T findExternalIdById(T id,
                     SearchScope searchScope)

Returns the external id of the entity with the given id in the given scope.

Parameters:

id - the id of the entity

searchScope - the scope in which to search for the external id

Returns:

the external id of the entity

findExternalIdByGlobalId

T findExternalIdByGlobalId(GlobalId globalId)

Returns the external id of the entity with the given id.

Parameters:

globalId - the global id of the entity

Returns:

the external id of the entity

findExternalIdByGlobalId

T findExternalIdByGlobalId(GlobalId globalId,
                           SearchScope searchScope)

Returns the external id of the entity with the given id in the given scope.

Parameters:

globalId - the global id of the entity

searchScope - the scope in which to search for the external id

Returns:

the external id of the entity

findIdByExternalId

T findIdByExternalId(T externalId)

Returns the id of the entity with the given external id.

Parameters:

externalId - the external id of the entity

Returns:

the id of the entity

findIdByExternalId

T findIdByExternalId(T externalId,
                     SearchScope searchScope)

Returns the id of the entity with the given external id in the given scope.

Parameters:

externalId - the external id of the entity

searchScope - the scope in which to search for the id

Returns:

the id of the entity

findGlobalIdByExternalId

GlobalId findGlobalIdByExternalId(T externalId)

Returns the global id of the entity with the given external id in the given scope.

Parameters:

externalId - the external id of the entity

Returns:

the global id of the entity

findGlobalIdByExternalId

GlobalId findGlobalIdByExternalId(T externalId,
                                  SearchScope searchScope)

Returns the global id of the entity with the given external id in the given scope.

Parameters:

externalId - the external id of the entity

searchScope - the scope in which to search for the id

Returns:

the global id of the entity

getEntityById

E getEntityById(T entityId)

Finds the entity with the given entity id. If no entity matches the given id, an exception is thrown.

Parameters:

entityId - the id of the entity to find

Returns:

the matching entity

Throws:

EntityNotFoundException - if entity cannot be found

getEntityById

E getEntityById(T entityId,
                SearchScope searchScope)

Finds the entity with the given entity id in the given scope. If no entity matches the given id, an exception is thrown.

Parameters:

entityId - the id of the entity to find

searchScope - the scope in which to search for the entity

Returns:

the matching entity

Throws:

EntityNotFoundException - if entity cannot be found

getEntityByGlobalId

E getEntityByGlobalId(GlobalId globalId)

Finds the entity with the given entity id. If no entity matches the given id, an exception is thrown.

Parameters:

globalId - the global id of the entity to find

Returns:

the matching entity

Throws:

EntityNotFoundException - if entity cannot be found

getEntityByGlobalId

E getEntityByGlobalId(GlobalId globalId,
                      SearchScope searchScope)

Finds the entity with the given entity id in the given scope. If no entity matches the given id, an exception is thrown.

Parameters:

globalId - the global id of the entity to find

searchScope - the scope in which to search for the entity

Returns:

the matching entity

Throws:

EntityNotFoundException - if entity cannot be found

findEntityById

E findEntityById(T id)

Finds the entity with the given entity id. If no entity matches the given id, null is returned.

Parameters:

id - the id of the entity to find

Returns:

the matching entity

findEntityById

E findEntityById(T id,
                 SearchScope searchScope)

Finds the entity with the given entity id in the given scope. If no entity matches the given id, null is returned.

Parameters:

id - the id of the entity to find

searchScope - the scope in which to search for the entity

Returns:

the matching entity

findEntityByGlobalId

E findEntityByGlobalId(GlobalId globalId)

Finds the entity with the given global id. If no entity matches the given global id, null is returned.

Parameters:

globalId - the global id of the entity to find

Returns:

the matching entity

findEntityByGlobalId

E findEntityByGlobalId(GlobalId globalId,
                       SearchScope searchScope)

Finds the entity with the given entity global id in the given scope. If no entity matches the given global id, null is returned.

Parameters:

globalId - the global id of the entity to find

searchScope - the scope in which to search for the entity (all-tenant scopes are not supported)

Returns:

the matching entity

findEntityByExternalId

E findEntityByExternalId(T externalId)

Finds the entity with the given external entity id. If no entity matches the given external id, null is returned.

Parameters:

externalId - the external id of the entity to find

Returns:

the matching entity

findEntityByExternalId

E findEntityByExternalId(T externalId,
                         SearchScope searchScope)

Finds the entity with the given external entity id in the given scope. If no entity matches the given external id, null is returned.

Parameters:

externalId - the external id of the entity to find

searchScope - the scope in which to search for the entity

Returns:

the matching entity

findEntity

E findEntity(Predicate predicate)

Finds the entity that matches the query with the given predicate. If no entity matches the query with the given predicate, null is returned. If more than one entity matches the query with the predicate, an exception is thrown.

Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Parameters:

predicate - the predicate to apply when executing the query

Returns:

the matching entity

findEntity

E findEntity(Predicate predicate,
             SearchScope searchScope)

Finds the entity that matches the query with the given predicate in the given scope. If no entity matches the query with the given predicate, null is returned. If more than one entity matches the query with the predicate, an exception is thrown.

Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Parameters:

predicate - the predicate to apply when executing the query

searchScope - the scope in which to search for the entity

Returns:

the matching entity

findEntities

List<E> findEntities(Predicate predicate)

Finds the entities that match the query with the given predicate. If no entity matches the query with the given predicate, an empty list is returned.

Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Parameters:

predicate - the predicate to apply when executing the query

Returns:

the matching entities

findEntities

List<E> findEntities(Predicate predicate,
                     SearchScope searchScope)

Finds the entities that match the query with the given predicate in the given scope. If no entity matches the query with the given predicate, an empty list is returned.

Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Parameters:

predicate - the predicate to apply when executing the query

searchScope - the scope in which to search for the entities

Returns:

the matching entities

countEntities

long countEntities(Predicate predicate)

Counts the entities that match the query with the given predicate.

Parameters:

predicate - the predicate to apply when executing the query

Returns:

the number of matching entities

countEntities

long countEntities(Predicate predicate,
                   SearchScope searchScope)

Counts the entities that match the query with the given predicate in the given scope.

Parameters:

predicate - the predicate to apply when executing the query

searchScope - the scope in which to count the number of entities

Returns:

the number of matching entities

findEntity

E findEntity(Q entityQuery)

Finds the entity that matches the given query. If no entity matches the given query, null is returned. If more than one entity matches the query, an exception is thrown.

Parameters:

entityQuery - the query to execute

Returns:

the matching entity

findEntity

E findEntity(Q entityQuery,
             SearchScope searchScope)

Finds the entity that matches the given query in the given scope. If no entity matches the given query, null is returned. If more than one entity matches the query, an exception is thrown.

Parameters:

entityQuery - the query to execute

searchScope - the scope in which to search for the entity

Returns:

the matching entity

findEntities

List<E> findEntities(Q entityQuery)

Finds the entities that match the given query. If no entity matches the given query, an empty list is returned.

Parameters:

entityQuery - the query to execute

Returns:

the matching entities

findEntities

List<E> findEntities(Q entityQuery,
                     SearchScope searchScope)

Finds the entities that match the given query in the given scope. If no entity matches the given query, an empty list is returned.

Parameters:

entityQuery - the query to execute

searchScope - the scope in which to search for the entities

Returns:

the matching entities

countEntities

long countEntities(Q entityQuery)

Counts the entities that match the given query.

Parameters:

entityQuery - the query to execute

Returns:

the number of matching entities

countEntities

long countEntities(Q entityQuery,
                   SearchScope searchScope)

Counts the entities that match the given query in the given scope.

Parameters:

entityQuery - the query to execute

searchScope - the scope in which to count number of entities

Returns:

the number of matching entities

addEntity

T addEntity(E entity,
            String description)

Adds the given ad-hoc entity. If the entity's id is set to UNDEFINED, the entity id is generated by the persistence component of the system and guaranteed to be unique. In all other cases, the contributor of the entity needs to ensure that the entity's id is unique.

Parameters:

entity - the ad-hoc entity to add

description - transient meta information regarding the reason to add the ad-hoc entity

Returns:

the persisted entity id

addEntityGeneric

GlobalId addEntityGeneric(E entity,
                          String description)

Adds the given ad-hoc work entity and returns the persisted global id.

If the global id is not set, a new global id is generated by the persistence component of the system and guaranteed to be unique. In all other cases, the contributor of the work object needs to ensure that the global id is unique within the tenant.

Parameters:

entity - the ad-hoc work object to add

description - transient meta information regarding the reason to add the ad-hoc work object

Returns:

the persisted global id