com.edorasware.commons.core.service.entity

Class BaseEntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,EB extends Entity.EntityBuilder<T,P,E,EB>,Q extends EntityQuery,QB extends EntityQuery.EntityQueryBuilder<Q,QB>,OC extends EntityOperandContainer<T,P>,W extends EntityModification<T,P,E,EB>,WB extends EntityModification.EntityModificationBuilder<T,P,E,EB,W,WB>,A extends EntityActionEvent<E,WB>,L extends EntityActionListener<A>,M extends EntityManager<T,P,E,EB,Q,QB,OC,W,WB>,PROV extends EntityProvider<P,?>,PERS extends EntityPersistence<T,E,Q>>

java.lang.Object

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

All Implemented Interfaces:

EntityService<T,P,E,Q>, Service

Direct Known Subclasses:

BaseDomainObjectDefinitionService, BaseDomainObjectService

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

Base class for all entity object services.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseEntityService(M manager, List<PROV> providers, PERS persistence, PredicatePostProcessor<E> predicatePostProcessor, List<L> actionListeners, CurrentTenantService currentTenantService, CurrentUserService currentUserService, EntityAuditHandler auditHandler, Registry serviceRegistry, LifeCycle lifeCycle, TimeProvider timeProvider)

Method Summary

Modifier and Type	Method and Description
void	addActionListener(L listener)
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.
T	addEntityGivenByProvider(E entity, 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.
protected E	addValidatedEntity(E entity, String description)
protected E	adjustEntityGivenByProvider(E entity)
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 query) Counts the entities that match the given query.
long	countEntities(Q query, SearchScope searchScope) Counts the entities that match the given query in the given scope.
protected abstract A	createActionEvent(EntityActionEvent.Type eventType, E oldEntity, E newEntity, WB modificationBuilder, String description)
protected E	ensureExternalIdIsDefined(E entity)
protected E	ensureGlobalIdIsDefined(E entity)
protected E	ensureIdIsDefined(E entity)
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 query) Finds the entities that match the given query.
List<E>	findEntities(Q 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(Q query) Finds the entity that matches the given query.
E	findEntity(Q query, 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 entityId) Finds the entity with the given entity id.
E	findEntityById(T entityId, 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.
protected E	findNonNullEntityByGlobalId(GlobalId globalId)
protected E	findNonNullEntityById(T entityId)
protected com.google.common.base.Optional<PROV>	findProvider(P providerIdToMatch)
protected EntityAuditHandler	getAuditHandler()
protected TenantId	getCurrentTenantId()
protected UserId	getCurrentUserId()
protected T	getDefinedExternalId(E entity, T defaultId)
protected GlobalId	getDefinedGlobalId(E entity)
protected T	getDefinedId(E entity)
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.
protected LifeCycle	getLifeCycle()
protected M	getManager()
protected PERS	getPersistence()
protected List<PROV>	getProviders()
protected Registry	getServiceRegistry()
protected TenantId	getSharedTenantId()
protected TimeProvider	getTimeProvider()
void	init() Life-cycle method to initialize the service before using the service for the first time.
protected T	insertEntityAndSendChangeEvents(E entity)
protected boolean	isMultiTenant()
protected abstract void	notifyProviders(E entity, Set<FieldChange> fieldChanges)
protected E	performInsert(E entity, String description)
void	removeActionListener(L listener)
protected void	sendActionPerformedEvent(EntityActionEvent.Type eventType, E oldEntity, E newEntity, String description)
protected void	sendActionWillBePerformedEvent(EntityActionEvent.Type eventType, E oldEntity, E newEntity, WB modificationBuilder, String description)
protected WB	sendActionWillBePerformedEvent(EntityActionEvent.Type eventType, E oldEntity, E complexNewEntity, W newModification, String description)
protected WB	sendActionWillBePerformedEvent(EntityActionEvent.Type eventType, E newEntity, String description)
protected W	sendActionWillBePerformedEvent(EntityActionEvent.Type eventType, E oldEntity, W newModification, String description)
protected abstract E	trimNonPersistentData(E entity)
protected abstract void	updateEntitySpecificCalculatedFieldsBeforeInsert(E newEntity, EB builder)
protected abstract void	validateEntityToAdd(E entity)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseEntityService

protected BaseEntityService(M manager,
                            List<PROV> providers,
                            PERS persistence,
                            PredicatePostProcessor<E> predicatePostProcessor,
                            List<L> actionListeners,
                            CurrentTenantService currentTenantService,
                            CurrentUserService currentUserService,
                            EntityAuditHandler auditHandler,
                            Registry serviceRegistry,
                            LifeCycle lifeCycle,
                            TimeProvider timeProvider)

Method Detail

getManager

protected M getManager()

getProviders

protected List<PROV> getProviders()

getPersistence

protected PERS getPersistence()

getCurrentTenantId

protected TenantId getCurrentTenantId()

getSharedTenantId

protected TenantId getSharedTenantId()

isMultiTenant

protected boolean isMultiTenant()

getCurrentUserId

protected UserId getCurrentUserId()

getAuditHandler

protected EntityAuditHandler getAuditHandler()

getServiceRegistry

protected Registry getServiceRegistry()

getLifeCycle

protected LifeCycle getLifeCycle()

findNonNullEntityById

protected E findNonNullEntityById(T entityId)

findNonNullEntityByGlobalId

protected E findNonNullEntityByGlobalId(GlobalId globalId)

init

public void init()

Description copied from interface: Service

Life-cycle method to initialize the service before using the service for the first time. This call should take place within an externally-provided transaction.

Specified by:

init in interface Service

findExternalIdById

public T findExternalIdById(T id)

Description copied from interface: EntityService

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

Specified by:

findExternalIdById in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

id - the id of the entity

Returns:

the external id of the entity

findExternalIdById

public T findExternalIdById(T id,
                            SearchScope searchScope)

Description copied from interface: EntityService

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

Specified by:

findExternalIdById in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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

public T findExternalIdByGlobalId(GlobalId globalId)

Description copied from interface: EntityService

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

Specified by:

findExternalIdByGlobalId in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

globalId - the global id of the entity

Returns:

the external id of the entity

findExternalIdByGlobalId

public T findExternalIdByGlobalId(GlobalId globalId,
                                  SearchScope searchScope)

Description copied from interface: EntityService

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

Specified by:

findExternalIdByGlobalId in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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

public T findIdByExternalId(T externalId)

Description copied from interface: EntityService

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

Specified by:

findIdByExternalId in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

externalId - the external id of the entity

Returns:

the id of the entity

findIdByExternalId

public T findIdByExternalId(T 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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

public GlobalId findGlobalIdByExternalId(T externalId)

Description copied from interface: EntityService

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

Specified by:

findGlobalIdByExternalId in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

externalId - the external id of the entity

Returns:

the global id of the entity

findGlobalIdByExternalId

public GlobalId findGlobalIdByExternalId(T externalId,
                                         SearchScope searchScope)

Description copied from interface: EntityService

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

Specified by:

findGlobalIdByExternalId in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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

public E getEntityById(T 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

entityId - the id of the entity to find

Returns:

the matching entity

getEntityById

public E getEntityById(T 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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(GlobalId 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

globalId - the global id of the entity to find

Returns:

the matching entity

getEntityByGlobalId

public E getEntityByGlobalId(GlobalId 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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(T 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

entityId - the id of the entity to find

Returns:

the matching entity

findEntityById

public E findEntityById(T 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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(GlobalId 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

globalId - the global id of the entity to find

Returns:

the matching entity

findEntityByGlobalId

public E findEntityByGlobalId(GlobalId 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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(T 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

externalId - the external id of the entity to find

Returns:

the matching entity

findEntityByExternalId

public E findEntityByExternalId(T 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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.

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

Specified by:

findEntity in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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.

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

Specified by:

findEntity in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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.

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

Specified by:

findEntities in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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.

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

Specified by:

findEntities in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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(Q 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

query - the query to execute

Returns:

the matching entity

findEntity

public E findEntity(Q 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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(Q 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

query - the query to execute

Returns:

the matching entities

findEntities

public List<E> findEntities(Q 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

query - the query to execute

searchScope - the scope in which to search for the entities

Returns:

the matching entities

countEntities

public long countEntities(Q query)

Description copied from interface: EntityService

Counts the entities that match the given query.

Specified by:

countEntities in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

query - the query to execute

Returns:

the number of matching entities

countEntities

public long countEntities(Q 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<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

Parameters:

query - the query to execute

searchScope - the scope in which to count number of entities

Returns:

the number of matching entities

addEntity

public final T addEntity(E entity,
                         String description)

Description copied from interface: EntityService

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.

Specified by:

addEntity in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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

public final GlobalId addEntityGeneric(E entity,
                                       String description)

Description copied from interface: EntityService

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.

Specified by:

addEntityGeneric in interface EntityService<T extends EntityId,P extends Id,E extends Entity<T,P>,Q extends EntityQuery>

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

validateEntityToAdd

protected abstract void validateEntityToAdd(E entity)

addValidatedEntity

protected E addValidatedEntity(E entity,
                               String description)

ensureIdIsDefined

protected final E ensureIdIsDefined(E entity)

ensureExternalIdIsDefined

protected final E ensureExternalIdIsDefined(E entity)

ensureGlobalIdIsDefined

protected final E ensureGlobalIdIsDefined(E entity)

getDefinedId

protected final T getDefinedId(E entity)

getDefinedGlobalId

protected final GlobalId getDefinedGlobalId(E entity)

getDefinedExternalId

protected final T getDefinedExternalId(E entity,
                                       T defaultId)

performInsert

protected E performInsert(E entity,
                          String description)

updateEntitySpecificCalculatedFieldsBeforeInsert

protected abstract void updateEntitySpecificCalculatedFieldsBeforeInsert(E newEntity,
                                                                         EB builder)

trimNonPersistentData

protected abstract E trimNonPersistentData(E entity)

insertEntityAndSendChangeEvents

protected T insertEntityAndSendChangeEvents(E entity)

addEntityGivenByProvider

public final T addEntityGivenByProvider(E entity,
                                        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 UNDEFINED, 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 skipDuplicates flag is set to true.

Parameters:

entity - the entity that comes from a provider to add

skipDuplicates - if true 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

adjustEntityGivenByProvider

protected E adjustEntityGivenByProvider(E entity)

findProvider

protected com.google.common.base.Optional<PROV> findProvider(P providerIdToMatch)

notifyProviders

protected abstract void notifyProviders(E entity,
                                        Set<FieldChange> fieldChanges)

sendActionWillBePerformedEvent

protected final WB sendActionWillBePerformedEvent(EntityActionEvent.Type eventType,
                                                  E newEntity,
                                                  String description)

sendActionWillBePerformedEvent

protected final WB sendActionWillBePerformedEvent(EntityActionEvent.Type eventType,
                                                  E oldEntity,
                                                  E complexNewEntity,
                                                  W newModification,
                                                  String description)

sendActionWillBePerformedEvent

protected final W sendActionWillBePerformedEvent(EntityActionEvent.Type eventType,
                                                 E oldEntity,
                                                 W newModification,
                                                 String description)

sendActionWillBePerformedEvent

protected final void sendActionWillBePerformedEvent(EntityActionEvent.Type eventType,
                                                    E oldEntity,
                                                    E newEntity,
                                                    WB modificationBuilder,
                                                    String description)

sendActionPerformedEvent

protected final void sendActionPerformedEvent(EntityActionEvent.Type eventType,
                                              E oldEntity,
                                              E newEntity,
                                              String description)

createActionEvent

protected abstract A createActionEvent(EntityActionEvent.Type eventType,
                                       E oldEntity,
                                       E newEntity,
                                       WB modificationBuilder,
                                       String description)

addActionListener

public void addActionListener(L listener)

removeActionListener

public void removeActionListener(L listener)

getTimeProvider

protected TimeProvider getTimeProvider()