com.edorasware.commons.core.service.entity

Class BaseEntityService<E extends Entity,EB extends Entity.EntityBuilder<E,EB>,OC extends EntityOperandContainer,W extends EntityModification<E,EB>,WB extends EntityModification.EntityModificationBuilder<E,EB,W,WB>,A extends EntityActionEvent<E,WB>,L extends EntityActionListener<A>,M extends EntityManager<E,EB,OC,W,WB>,PROV extends EntityProvider<?>,PERS extends EntityPersistence<E>>

java.lang.Object

com.edorasware.commons.core.service.entity.BaseEntityService<E,EB,OC,W,WB,A,L,M,PROV,PERS>

All Implemented Interfaces:

EntityService<E>

Direct Known Subclasses:

DefaultAnyWorkObjectDefinitionService, DefaultAnyWorkObjectService

public abstract class BaseEntityService<E extends Entity,EB extends Entity.EntityBuilder<E,EB>,OC extends EntityOperandContainer,W extends EntityModification<E,EB>,WB extends EntityModification.EntityModificationBuilder<E,EB,W,WB>,A extends EntityActionEvent<E,WB>,L extends EntityActionListener<A>,M extends EntityManager<E,EB,OC,W,WB>,PROV extends EntityProvider<?>,PERS extends EntityPersistence<E>>
extends Object
implements EntityService<E>

Base class for all entity object services.

Method Summary

Modifier and Type	Method and Description
void	addActionListener(L listener) Deprecated.
String	addEntityGivenByProvider(E entity, String parentEntityId, boolean skipDuplicates, String description) Adds the given entity that comes from a provider, after converting all references to other entities from external ids to primary ids.
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(Query query) Counts the entities that match the given query.
long	countEntities(Query query, 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(Query query) Finds the entities that match the given query.
List<E>	findEntities(Query query, 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(Query query) Finds the entity that matches the given query.
E	findEntity(Query query, SearchScope searchScope) Finds the entity that matches the given query in the given scope.
E	findEntityByExternalId(String externalId) Finds the entity with the given external entity id.
E	findEntityByExternalId(String externalId, SearchScope searchScope) Finds the entity with the given external entity id in the given scope.
E	findEntityByGlobalId(String globalId) Finds the entity with the given global id.
E	findEntityByGlobalId(String globalId, SearchScope searchScope) Finds the entity with the given entity global id in the given scope.
E	findEntityById(String entityId) Finds the entity with the given entity id.
E	findEntityById(String entityId, SearchScope searchScope) Finds the entity with the given entity id in the given scope.
String	findIdByExternalId(String externalId) Returns the id of the entity with the given external id.
String	findIdByExternalId(String externalId, SearchScope searchScope) Returns the id of the entity with the given external id in the given scope.
E	getEntityByGlobalId(String globalId) Finds the entity with the given entity id.
E	getEntityByGlobalId(String globalId, SearchScope searchScope) Finds the entity with the given entity id in the given scope.
E	getEntityById(String entityId) Finds the entity with the given entity id.
E	getEntityById(String entityId, SearchScope searchScope) Finds the entity with the given entity id in the given scope.
void	removeActionListener(L listener) Deprecated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.edorasware.commons.core.service.entity.EntityService

create, create

Method Detail

findIdByExternalId

public String findIdByExternalId(String externalId)

Description copied from interface: EntityService

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

Specified by:

findIdByExternalId in interface EntityService<E extends Entity>

Parameters:

externalId - the external id of the entity

Returns:

the id of the entity

findIdByExternalId

public String findIdByExternalId(String externalId,
                                 SearchScope searchScope)

Description copied from interface: EntityService

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

Specified by:

findIdByExternalId in interface EntityService<E extends Entity>

Parameters:

externalId - the external id of the entity

searchScope - the scope in which to search for the id

Returns:

the id of the entity

getEntityById

public E getEntityById(String entityId)

Description copied from interface: EntityService

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

Specified by:

getEntityById in interface EntityService<E extends Entity>

Parameters:

entityId - the id of the entity to find

Returns:

the matching entity

getEntityById

public E getEntityById(String entityId,
                       SearchScope searchScope)

Description copied from interface: EntityService

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

Specified by:

getEntityById in interface EntityService<E extends Entity>

Parameters:

entityId - the id of the entity to find

searchScope - the scope in which to search for the entity

Returns:

the matching entity

getEntityByGlobalId

public E getEntityByGlobalId(String globalId)

Description copied from interface: EntityService

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

Specified by:

getEntityByGlobalId in interface EntityService<E extends Entity>

Parameters:

globalId - the global id of the entity to find

Returns:

the matching entity

getEntityByGlobalId

public E getEntityByGlobalId(String globalId,
                             SearchScope searchScope)

Description copied from interface: EntityService

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

Specified by:

getEntityByGlobalId in interface EntityService<E extends Entity>

Parameters:

globalId - the global id of the entity to find

searchScope - the scope in which to search for the entity

Returns:

the matching entity

findEntityById

public E findEntityById(String entityId)

Description copied from interface: EntityService

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

Specified by:

findEntityById in interface EntityService<E extends Entity>

Parameters:

entityId - the id of the entity to find

Returns:

the matching entity

findEntityById

public E findEntityById(String entityId,
                        SearchScope searchScope)

Description copied from interface: EntityService

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

Specified by:

findEntityById in interface EntityService<E extends Entity>

Parameters:

entityId - the id of the entity to find

searchScope - the scope in which to search for the entity

Returns:

the matching entity

findEntityByGlobalId

public E findEntityByGlobalId(String globalId)

Description copied from interface: EntityService

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

Specified by:

findEntityByGlobalId in interface EntityService<E extends Entity>

Parameters:

globalId - the global id of the entity to find

Returns:

the matching entity

findEntityByGlobalId

public E findEntityByGlobalId(String globalId,
                              SearchScope searchScope)

Description copied from interface: EntityService

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

Specified by:

findEntityByGlobalId in interface EntityService<E extends Entity>

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

public E findEntityByExternalId(String externalId)

Description copied from interface: EntityService

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

Specified by:

findEntityByExternalId in interface EntityService<E extends Entity>

Parameters:

externalId - the external id of the entity to find

Returns:

the matching entity

findEntityByExternalId

public E findEntityByExternalId(String externalId,
                                SearchScope searchScope)

Description copied from interface: EntityService

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

Specified by:

findEntityByExternalId in interface EntityService<E extends Entity>

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

public E findEntity(Predicate predicate)

Description copied from interface: EntityService

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. <p> Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Specified by:

findEntity in interface EntityService<E extends Entity>

Parameters:

predicate - the predicate to apply when executing the query

Returns:

the matching entity

findEntity

public E findEntity(Predicate predicate,
                    SearchScope searchScope)

Description copied from interface: EntityService

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. <p> Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Specified by:

findEntity in interface EntityService<E extends Entity>

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

public List<E> findEntities(Predicate predicate)

Description copied from interface: EntityService

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. <p> Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Specified by:

findEntities in interface EntityService<E extends Entity>

Parameters:

predicate - the predicate to apply when executing the query

Returns:

the matching entities

findEntities

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

Description copied from interface: EntityService

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. <p> Note: No sorting, paging, nor query hints are applied. This can become a potential query performance issue.

Specified by:

findEntities in interface EntityService<E extends Entity>

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

public long countEntities(Predicate predicate)

Description copied from interface: EntityService

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

Specified by:

countEntities in interface EntityService<E extends Entity>

Parameters:

predicate - the predicate to apply when executing the query

Returns:

the number of matching entities

countEntities

public long countEntities(Predicate predicate,
                          SearchScope searchScope)

Description copied from interface: EntityService

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

Specified by:

countEntities in interface EntityService<E extends Entity>

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

public E findEntity(Query query)

Description copied from interface: EntityService

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.

Specified by:

findEntity in interface EntityService<E extends Entity>

Parameters:

query - the query to execute

Returns:

the matching entity

findEntity

public E findEntity(Query query,
                    SearchScope searchScope)

Description copied from interface: EntityService

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.

Specified by:

findEntity in interface EntityService<E extends Entity>

Parameters:

query - the query to execute

searchScope - the scope in which to search for the entity

Returns:

the matching entity

findEntities

public List<E> findEntities(Query query)

Description copied from interface: EntityService

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

Specified by:

findEntities in interface EntityService<E extends Entity>

Parameters:

query - the query to execute

Returns:

the matching entities

findEntities

public List<E> findEntities(Query query,
                            SearchScope searchScope)

Description copied from interface: EntityService

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

Specified by:

findEntities in interface EntityService<E extends Entity>

Parameters:

query - the query to execute

searchScope - the scope in which to search for the entities

Returns:

the matching entities

countEntities

public long countEntities(Query query)

Description copied from interface: EntityService

Counts the entities that match the given query.

Specified by:

countEntities in interface EntityService<E extends Entity>

Parameters:

query - the query to execute

Returns:

the number of matching entities

countEntities

public long countEntities(Query query,
                          SearchScope searchScope)

Description copied from interface: EntityService

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

Specified by:

countEntities in interface EntityService<E extends Entity>

Parameters:

query - the query to execute

searchScope - the scope in which to count number of entities

Returns:

the number of matching entities

addEntityGivenByProvider

public final String addEntityGivenByProvider(E entity,
                                             String parentEntityId,
                                             boolean skipDuplicates,
                                             String description)

Adds the given entity that comes from a provider, after converting all references to other entities from external ids to primary ids. If the entity’s id is set to null, the entity id is generated by the persistence component of the system and guaranteed to be unique. In all other cases, the provider of the entity needs to ensure that the entity’s id is unique. If the entity is already persisted, the action is silently aborted if the <i>skipDuplicates</i> flag is set to <i>true</i>.

Parameters:

entity - the entity that comes from a provider to add

skipDuplicates - if <i>true</i> and entity is already persisted, abort silently

description - transient meta information regarding the reason to add the entity that comes from a provider

Returns:

the persisted entity id or null if the entity is already persisted

addActionListener

@Deprecated
public void addActionListener(L listener)

Deprecated.

removeActionListener

@Deprecated
public void removeActionListener(L listener)

Deprecated.