com.edorasware.commons.core.service.entity

Class BaseDomainObjectService<T extends EntityId,D extends EntityId,P extends Id,ED extends DomainObjectDefinition<D,P>,E extends DomainObject<T,D,P>,EB extends DomainObject.DomainObjectBuilder<T,D,P,E,EB>,Q extends DomainObjectQuery,QB extends EntityQuery.EntityQueryBuilder<Q,QB>,OC extends DomainObjectOperandContainer<T,D,P>,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,A extends DomainObjectActionEvent<E,WB>,L extends DomainObjectActionListener<A>,M extends DomainObjectManager<T,D,P,E,EB,Q,QB,OC,W,WB>,PROV extends DomainObjectProvider<T,D,P,?,?>,PERS extends EntityPersistence<T,E,Q>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

java.lang.Object

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

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

All Implemented Interfaces:

DomainObjectService<T,D,P,E,Q,W,WB,U,UB>, EntityService<T,P,E,Q>, Service

Direct Known Subclasses:

BaseWorkObjectService

public abstract class BaseDomainObjectService<T extends EntityId,D extends EntityId,P extends Id,ED extends DomainObjectDefinition<D,P>,E extends DomainObject<T,D,P>,EB extends DomainObject.DomainObjectBuilder<T,D,P,E,EB>,Q extends DomainObjectQuery,QB extends EntityQuery.EntityQueryBuilder<Q,QB>,OC extends DomainObjectOperandContainer<T,D,P>,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,A extends DomainObjectActionEvent<E,WB>,L extends DomainObjectActionListener<A>,M extends DomainObjectManager<T,D,P,E,EB,Q,QB,OC,W,WB>,PROV extends DomainObjectProvider<T,D,P,?,?>,PERS extends EntityPersistence<T,E,Q>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>
extends BaseEntityService<T,P,E,EB,Q,QB,OC,W,WB,A,L,M,PROV,PERS>
implements DomainObjectService<T,D,P,E,Q,W,WB,U,UB>

Base class for all domain object services.

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

BaseDomainObjectService(M manager, List<PROV> providers, PERS persistence, PredicatePostProcessor<E> predicatePostProcessor, List<L> actionListeners, CurrentTenantService currentTenantService, CurrentUserService currentUserService, Class<? extends DomainObjectDefinitionService<D,P,ED,?>> definitionServiceClass, EntityAuditHandler auditHandler, Registry serviceRegistry, LifeCycle lifeCycle, TimeProvider timeProvider)

Method Summary

Modifier and Type	Method and Description
protected E	adjustDefinitionReference(E entity) Reads the entity's definition id which references the external id of the entity definition, and adjusts the entity to reference the id of the entity definition instead.
E	apply(U update, String description) Applies an entity update.
WB	createModificationBuilder() Creates a new type-safe modification builder.
WB	createModificationBuilder(W modification) Creates a new type-safe modification builder based on the given template modification.
void	deleteVariable(GlobalId globalId, String name, String description) Deletes the variable with the given name from the entity with given globalId.
<V> void	deleteVariable(GlobalId globalId, VariableName<V,?> name, String description) Deletes the variable with the given name from the entity with given globalId.
void	deleteVariable(T id, String name, String description) Deletes the variable with the given name from the entity with given id.
<V> void	deleteVariable(T id, VariableName<V,?> name, String description) Deletes the variable with the given name from the entity with given id.
void	deleteVariables(GlobalId globalId, Collection<String> variables, String description) Deletes the variables from the collection of variable names from the entity with given globalId.
void	deleteVariables(T entityId, Collection<String> variables, String description) Deletes the variables from the collection of variable names from the entity with given entityId.
protected DomainObjectDefinitionService<D,P,ED,?>	getDefinitionService()
protected abstract W	getFinalModification(U update) Returns the final modification corresponding to the given update.
protected E	getModifiedEntityForUpdate(E baseEntity, W modification)
void	init() Life-cycle method to initialize the service before using the service for the first time.
protected EntityActionEvent.Type	mapFieldIdToActionType(FieldId fieldId)
protected void	notifyProviders(E entity, Set<FieldChange> fieldChanges)
protected void	performDelete(T entityId, String description)
protected void	performStateUpdateReceivedFromProvider(T entityId, State newState)
protected void	performStateUpdateReceivedFromProvider(T entityId, State newState, String cause)
protected E	performUpdate(E entity, W modification, boolean notifyProvider, String description)
void	putVariable(GlobalId globalId, String name, Object value, String description) Associates the given variable with the specified entity.
<V> void	putVariable(GlobalId globalId, VariableName<V,?> name, V value, String description) Associates the given variable with the specified entity.
void	putVariable(T id, String name, Object value, String description) Associates the given variable with the specified entity.
<V> void	putVariable(T id, VariableName<V,?> name, V value, String description) Associates the given variable with the specified entity.
void	putVariables(GlobalId globalId, Map<String,Object> variables, String description) Associates the given variables with the specified entity.
void	putVariables(GlobalId globalId, VariableMap variables, String description) Associates the given variables with the specified entity.
void	putVariables(T entityId, Map<String,Object> variables, String description) Associates the given variables with the specified entity.
void	putVariables(T entityId, VariableMap variables, String description) Associates the given variables with the specified entity.
void	setDescription(GlobalId globalId, String description, String comment) Sets the description of the specified entity.
void	setDescription(T entityId, String description, String comment) Sets the description of the specified entity.
void	setName(GlobalId globalId, String name, String description) Sets the name of the specified entity.
void	setName(T entityId, String name, String description) Sets the name of the specified entity.
void	setState(GlobalId globalId, State state, String description) Sets the state of the specified entity.
void	setState(T entityId, State state, String description) Sets the state of the specified entity.
void	setSubState(GlobalId globalId, State subState, String description) Sets the sub state of the specified entity.
void	setSubState(T entityId, State subState, String description) Sets the sub state of the specified entity.
T	startEntity(D definitionId, Map<String,Object> variables) Starts a new entity based on the definition with the given id.
T	startEntity(D definitionId, String name, Object value) Starts a new entity based on the definition with the given id.
T	startEntity(D definitionId, VariableMap variables) Starts a new entity based on the definition with the given id.
<V> T	startEntity(D definitionId, VariableName<V,?> name, V value) Starts a new entity based on the definition with the given id.
protected E	trimNonPersistentData(E entity)
protected abstract void	updateDomainObjectSpecificCalculatedFieldsBeforeInsert(E newEntity, EB builder)
protected abstract void	updateDomainObjectSpecificCalculatedFieldsBeforeUpdate(E oldEntity, E newEntity, Collection<FieldChange> fieldChanges, Date currentTime, EB builder)
protected void	updateEntityAndSendChangeEvents(E entity, Set<FieldChange> fieldChanges, boolean notifyProvider)
protected void	updateEntitySpecificCalculatedFieldsBeforeInsert(E newEntity, EB builder)
protected void	validateEntityToAdd(E entity)

Methods inherited from class com.edorasware.commons.core.service.entity.BaseEntityService

addActionListener, addEntity, addEntityGeneric, addEntityGivenByProvider, addValidatedEntity, adjustEntityGivenByProvider, countEntities, countEntities, countEntities, countEntities, createActionEvent, ensureExternalIdIsDefined, ensureGlobalIdIsDefined, ensureIdIsDefined, findEntities, findEntities, findEntities, findEntities, findEntity, findEntity, findEntity, findEntity, findEntityByExternalId, findEntityByExternalId, findEntityByGlobalId, findEntityByGlobalId, findEntityById, findEntityById, findExternalIdByGlobalId, findExternalIdByGlobalId, findExternalIdById, findExternalIdById, findGlobalIdByExternalId, findGlobalIdByExternalId, findIdByExternalId, findIdByExternalId, findNonNullEntityByGlobalId, findNonNullEntityById, findProvider, getAuditHandler, getCurrentTenantId, getCurrentUserId, getDefinedExternalId, getDefinedGlobalId, getDefinedId, getEntityByGlobalId, getEntityByGlobalId, getEntityById, getEntityById, getLifeCycle, getManager, getPersistence, getProviders, getServiceRegistry, getSharedTenantId, getTimeProvider, insertEntityAndSendChangeEvents, isMultiTenant, performInsert, removeActionListener, sendActionPerformedEvent, sendActionWillBePerformedEvent, sendActionWillBePerformedEvent, sendActionWillBePerformedEvent, sendActionWillBePerformedEvent

Methods inherited from class java.lang.Object

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

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

createReadableUpdateBuilder, createUpdateBuilder

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

addEntity, addEntityGeneric, countEntities, countEntities, countEntities, countEntities, findEntities, findEntities, findEntities, findEntities, findEntity, findEntity, findEntity, findEntity, findEntityByExternalId, findEntityByExternalId, findEntityByGlobalId, findEntityByGlobalId, findEntityById, findEntityById, findExternalIdByGlobalId, findExternalIdByGlobalId, findExternalIdById, findExternalIdById, findGlobalIdByExternalId, findGlobalIdByExternalId, findIdByExternalId, findIdByExternalId, getEntityByGlobalId, getEntityByGlobalId, getEntityById, getEntityById

Constructor Detail

BaseDomainObjectService

protected BaseDomainObjectService(M manager,
                                  List<PROV> providers,
                                  PERS persistence,
                                  PredicatePostProcessor<E> predicatePostProcessor,
                                  List<L> actionListeners,
                                  CurrentTenantService currentTenantService,
                                  CurrentUserService currentUserService,
                                  Class<? extends DomainObjectDefinitionService<D,P,ED,?>> definitionServiceClass,
                                  EntityAuditHandler auditHandler,
                                  Registry serviceRegistry,
                                  LifeCycle lifeCycle,
                                  TimeProvider timeProvider)

Method Detail

getDefinitionService

protected DomainObjectDefinitionService<D,P,ED,?> getDefinitionService()

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

Overrides:

init in class BaseEntityService<T extends EntityId,P extends Id,E extends DomainObject<T,D,P>,EB extends DomainObject.DomainObjectBuilder<T,D,P,E,EB>,Q extends DomainObjectQuery,QB extends EntityQuery.EntityQueryBuilder<Q,QB>,OC extends DomainObjectOperandContainer<T,D,P>,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,A extends DomainObjectActionEvent<E,WB>,L extends DomainObjectActionListener<A>,M extends DomainObjectManager<T,D,P,E,EB,Q,QB,OC,W,WB>,PROV extends DomainObjectProvider<T,D,P,?,?>,PERS extends EntityPersistence<T,E,Q>>

setName

public void setName(T entityId,
                    String name,
                    String description)

Description copied from interface: DomainObjectService

Sets the name of the specified entity.

Specified by:

setName in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

entityId - the id of the entity for which to set the name

name - the name to set on the entity

description - transient meta information regarding the reason to set the name of the entity

setName

public void setName(GlobalId globalId,
                    String name,
                    String description)

Description copied from interface: DomainObjectService

Sets the name of the specified entity.

Specified by:

setName in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

globalId - the global id of the entity for which to set the name

name - the name to set on the entity

description - transient meta information regarding the reason to set the name of the entity

setDescription

public void setDescription(T entityId,
                           String description,
                           String comment)

Description copied from interface: DomainObjectService

Sets the description of the specified entity.

Specified by:

setDescription in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

entityId - the id of the entity for which to set the description

description - the description to set on the entity

comment - transient meta information regarding the reason to set the description of the entity

setDescription

public void setDescription(GlobalId globalId,
                           String description,
                           String comment)

Description copied from interface: DomainObjectService

Sets the description of the specified entity.

Specified by:

setDescription in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

globalId - the global id of the entity for which to set the description

description - the description to set on the entity

comment - transient meta information regarding the reason to set the description of the entity

setState

public void setState(T entityId,
                     State state,
                     String description)

Description copied from interface: DomainObjectService

Sets the state of the specified entity.

Specified by:

setState in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

entityId - the id of the entity for which to set the state

state - the state to set on the entity

description - transient meta information regarding the reason to set the state of the entity

setState

public void setState(GlobalId globalId,
                     State state,
                     String description)

Description copied from interface: DomainObjectService

Sets the state of the specified entity.

Specified by:

setState in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

globalId - the global id of the entity for which to set the state

state - the state to set on the entity

description - transient meta information regarding the reason to set the state of the entity

setSubState

public void setSubState(T entityId,
                        State subState,
                        String description)

Description copied from interface: DomainObjectService

Sets the sub state of the specified entity.

Specified by:

setSubState in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

entityId - the id of the entity for which to set the sub state

subState - the sub state to set on the entity

description - transient meta information regarding the reason to set the sub state of the entity

setSubState

public void setSubState(GlobalId globalId,
                        State subState,
                        String description)

Description copied from interface: DomainObjectService

Sets the sub state of the specified entity.

Specified by:

setSubState in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

globalId - the global id of the entity for which to set the sub state

subState - the sub state to set on the entity

description - transient meta information regarding the reason to set the sub state of the entity

putVariable

public void putVariable(T id,
                        String name,
                        Object value,
                        String description)

Description copied from interface: DomainObjectService

Associates the given variable with the specified entity.

Specified by:

putVariable in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

id - the id of the entity for which to associate the variable with

name - the name of the variable to associate with the entity

value - the value of the variable to associate with the entity

description - transient meta information regarding the reason to associate variable with the entity

putVariable

public void putVariable(GlobalId globalId,
                        String name,
                        Object value,
                        String description)

Description copied from interface: DomainObjectService

Associates the given variable with the specified entity.

Specified by:

putVariable in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

globalId - the global id of the entity to be updated

name - the name of the variable to associate with the entity

value - the value of the variable to associate with the entity

description - transient meta information regarding the reason to associate variable with the entity

putVariable

public <V> void putVariable(T id,
                            VariableName<V,?> name,
                            V value,
                            String description)

Description copied from interface: DomainObjectService

Associates the given variable with the specified entity.

Specified by:

putVariable in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Type Parameters:

V - the expected transient type of the variable

Parameters:

id - the id of the entity for which to associate the variable with

name - the name of the variable to associate with the entity

value - the value of the variable to associate with the entity

description - transient meta information regarding the reason to associate variable with the entity

putVariable

public <V> void putVariable(GlobalId globalId,
                            VariableName<V,?> name,
                            V value,
                            String description)

Description copied from interface: DomainObjectService

Associates the given variable with the specified entity.

Specified by:

putVariable in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Type Parameters:

V - the expected transient type of the variable

Parameters:

globalId - the global id of the entity to be updated

name - the name of the variable to associate with the entity

value - the value of the variable to associate with the entity

description - transient meta information regarding the reason to associate variable with the entity

putVariables

public void putVariables(T entityId,
                         Map<String,Object> variables,
                         String description)

Description copied from interface: DomainObjectService

Associates the given variables with the specified entity.

Specified by:

putVariables in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

entityId - the id of the entity for which to associate the variables with

variables - the variables to associate with the entity

description - transient meta information regarding the reason to associate variables with the entity

putVariables

public void putVariables(GlobalId globalId,
                         Map<String,Object> variables,
                         String description)

Description copied from interface: DomainObjectService

Associates the given variables with the specified entity.

Specified by:

putVariables in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

globalId - the global id of the entity to be updated

variables - the variables to associate with the entity

description - transient meta information regarding the reason to associate variables with the entity

putVariables

public void putVariables(T entityId,
                         VariableMap variables,
                         String description)

Description copied from interface: DomainObjectService

Associates the given variables with the specified entity.

Specified by:

putVariables in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

entityId - the id of the entity for which to associate the variables with

variables - the variables to associate with the entity

description - transient meta information regarding the reason to associate variables with the entity

putVariables

public void putVariables(GlobalId globalId,
                         VariableMap variables,
                         String description)

Description copied from interface: DomainObjectService

Associates the given variables with the specified entity.

Specified by:

putVariables in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

globalId - the global id of the entity to be updated

variables - the variables to associate with the entity

description - transient meta information regarding the reason to associate variables with the entity

deleteVariable

public void deleteVariable(T id,
                           String name,
                           String description)

Description copied from interface: DomainObjectService

Deletes the variable with the given name from the entity with given id. In the case when variable does not exist no action is taken.

Specified by:

deleteVariable in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

id - the entity id from which variable is deleted

name - the variable name

description - transient meta information regarding the reason to delete variable from the entity

deleteVariable

public void deleteVariable(GlobalId globalId,
                           String name,
                           String description)

Description copied from interface: DomainObjectService

Deletes the variable with the given name from the entity with given globalId. In the case when variable does not exist no action is taken.

Specified by:

deleteVariable in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

globalId - the entity globalId from which variable is deleted

name - the variable name

description - transient meta information regarding the reason to delete variable from the entity

deleteVariable

public <V> void deleteVariable(T id,
                               VariableName<V,?> name,
                               String description)

Description copied from interface: DomainObjectService

Deletes the variable with the given name from the entity with given id. In the case when variable does not exist no action is taken.

Specified by:

deleteVariable in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

id - the entity globalId from which variable is deleted

name - the variable name

description - transient meta information regarding the reason to delete variable from the entity

deleteVariable

public <V> void deleteVariable(GlobalId globalId,
                               VariableName<V,?> name,
                               String description)

Description copied from interface: DomainObjectService

Deletes the variable with the given name from the entity with given globalId. In the case when variable does not exist no action is taken.

Specified by:

deleteVariable in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

globalId - the entity globalId from which variable is deleted

name - the variable name

description - transient meta information regarding the reason to delete variable from the entity

deleteVariables

public void deleteVariables(T entityId,
                            Collection<String> variables,
                            String description)

Description copied from interface: DomainObjectService

Deletes the variables from the collection of variable names from the entity with given entityId. In the case when variable does not exist no action is taken.

Specified by:

deleteVariables in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

entityId - the entity id from which variable is deleted

variables - the collection of variable names to delete

description - transient meta information regarding the reason to delete variable from the entity

deleteVariables

public void deleteVariables(GlobalId globalId,
                            Collection<String> variables,
                            String description)

Description copied from interface: DomainObjectService

Deletes the variables from the collection of variable names from the entity with given globalId. In the case when variable does not exist no action is taken.

Specified by:

deleteVariables in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

globalId - the entity globalId from which variable is deleted

variables - the collection of variable names to delete

description - transient meta information regarding the reason to delete variable from the entity

startEntity

public T startEntity(D definitionId,
                     String name,
                     Object value)

Description copied from interface: DomainObjectService

Starts a new entity based on the definition with the given id. The given variable is used to build the initial data set of the entity that is started. Each started entity can be uniquely identified by its id.

Specified by:

startEntity in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

definitionId - the id of the definition for which to start a new entity

name - the name of the variable to build the initial data set of the entity that is started

value - the value of the variable to build the initial data set of the entity that is started

Returns:

the id of the started entity

startEntity

public <V> T startEntity(D definitionId,
                         VariableName<V,?> name,
                         V value)

Description copied from interface: DomainObjectService

Starts a new entity based on the definition with the given id. The given variable is used to build the initial data set of the entity that is started. Each started entity can be uniquely identified by its id.

Specified by:

startEntity in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Type Parameters:

V - the expected transient type of the variable

Parameters:

definitionId - the id of the definition for which to start a new entity

name - the name of the variable to build the initial data set of the entity that is started

value - the value of the variable to build the initial data set of the entity that is started

Returns:

the id of the started entity

startEntity

public T startEntity(D definitionId,
                     Map<String,Object> variables)

Description copied from interface: DomainObjectService

Starts a new entity based on the definition with the given id. The given variables are used to build the initial data set of the entity that is started. Each started entity can be uniquely identified by its id.

Specified by:

startEntity in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

definitionId - the id of the definition for which to start a new entity

variables - the variables to build the initial data set of the entity that is started

Returns:

the id of the started entity

startEntity

public T startEntity(D definitionId,
                     VariableMap variables)

Description copied from interface: DomainObjectService

Starts a new entity based on the definition with the given id. The given variables are used to build the initial data set of the entity that is started. Each started entity can be uniquely identified by its id.

Specified by:

startEntity in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

definitionId - the id of the definition for which to start a new entity

variables - the variables to build the initial data set of the entity that is started

Returns:

the id of the started entity

validateEntityToAdd

protected void validateEntityToAdd(E entity)

Specified by:

validateEntityToAdd in class BaseEntityService<T extends EntityId,P extends Id,E extends DomainObject<T,D,P>,EB extends DomainObject.DomainObjectBuilder<T,D,P,E,EB>,Q extends DomainObjectQuery,QB extends EntityQuery.EntityQueryBuilder<Q,QB>,OC extends DomainObjectOperandContainer<T,D,P>,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,A extends DomainObjectActionEvent<E,WB>,L extends DomainObjectActionListener<A>,M extends DomainObjectManager<T,D,P,E,EB,Q,QB,OC,W,WB>,PROV extends DomainObjectProvider<T,D,P,?,?>,PERS extends EntityPersistence<T,E,Q>>

updateEntitySpecificCalculatedFieldsBeforeInsert

protected void updateEntitySpecificCalculatedFieldsBeforeInsert(E newEntity,
                                                                EB builder)

Specified by:

updateEntitySpecificCalculatedFieldsBeforeInsert in class BaseEntityService<T extends EntityId,P extends Id,E extends DomainObject<T,D,P>,EB extends DomainObject.DomainObjectBuilder<T,D,P,E,EB>,Q extends DomainObjectQuery,QB extends EntityQuery.EntityQueryBuilder<Q,QB>,OC extends DomainObjectOperandContainer<T,D,P>,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,A extends DomainObjectActionEvent<E,WB>,L extends DomainObjectActionListener<A>,M extends DomainObjectManager<T,D,P,E,EB,Q,QB,OC,W,WB>,PROV extends DomainObjectProvider<T,D,P,?,?>,PERS extends EntityPersistence<T,E,Q>>

updateDomainObjectSpecificCalculatedFieldsBeforeInsert

protected abstract void updateDomainObjectSpecificCalculatedFieldsBeforeInsert(E newEntity,
                                                                               EB builder)

trimNonPersistentData

protected E trimNonPersistentData(E entity)

Specified by:

trimNonPersistentData in class BaseEntityService<T extends EntityId,P extends Id,E extends DomainObject<T,D,P>,EB extends DomainObject.DomainObjectBuilder<T,D,P,E,EB>,Q extends DomainObjectQuery,QB extends EntityQuery.EntityQueryBuilder<Q,QB>,OC extends DomainObjectOperandContainer<T,D,P>,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,A extends DomainObjectActionEvent<E,WB>,L extends DomainObjectActionListener<A>,M extends DomainObjectManager<T,D,P,E,EB,Q,QB,OC,W,WB>,PROV extends DomainObjectProvider<T,D,P,?,?>,PERS extends EntityPersistence<T,E,Q>>

adjustDefinitionReference

protected final E adjustDefinitionReference(E entity)

Reads the entity's definition id which references the external id of the entity definition, and adjusts the entity to reference the id of the entity definition instead. If the reference is invalid, use null as the definition reference.

Parameters:

entity - the entity to adjust

Returns:

the entity with its potentially adjusted definition id

createModificationBuilder

public WB createModificationBuilder()

Description copied from interface: DomainObjectService

Creates a new type-safe modification builder.

Specified by:

createModificationBuilder in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Returns:

the type-safe modification builder

createModificationBuilder

public WB createModificationBuilder(W modification)

Description copied from interface: DomainObjectService

Creates a new type-safe modification builder based on the given template modification.

Specified by:

createModificationBuilder in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

modification - the template modification

Returns:

the type-safe modification builder

apply

public E apply(U update,
               String description)

Description copied from interface: DomainObjectService

Applies an entity update.

Specified by:

apply in interface DomainObjectService<T extends EntityId,D extends EntityId,P extends Id,E extends DomainObject<T,D,P>,Q extends DomainObjectQuery,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

Parameters:

update - the update to be applied

description - transient meta information regarding the reason for the change

Returns:

the updated entity

getFinalModification

protected abstract W getFinalModification(U update)

Returns the final modification corresponding to the given update. This is needed because although the update can deliver a valid modification in most cases, some updates need extra evaluation within the service to create a correct modification object (e.g. a new work object parent id needs to be turned into a path).

Parameters:

update - the incoming update

Returns:

the final modification to be applied

performUpdate

protected E performUpdate(E entity,
                          W modification,
                          boolean notifyProvider,
                          String description)

getModifiedEntityForUpdate

protected E getModifiedEntityForUpdate(E baseEntity,
                                       W modification)

mapFieldIdToActionType

protected EntityActionEvent.Type mapFieldIdToActionType(FieldId fieldId)

updateDomainObjectSpecificCalculatedFieldsBeforeUpdate

protected abstract void updateDomainObjectSpecificCalculatedFieldsBeforeUpdate(E oldEntity,
                                                                               E newEntity,
                                                                               Collection<FieldChange> fieldChanges,
                                                                               Date currentTime,
                                                                               EB builder)

performStateUpdateReceivedFromProvider

protected void performStateUpdateReceivedFromProvider(T entityId,
                                                      State newState)

performStateUpdateReceivedFromProvider

protected void performStateUpdateReceivedFromProvider(T entityId,
                                                      State newState,
                                                      String cause)

performDelete

protected void performDelete(T entityId,
                             String description)

updateEntityAndSendChangeEvents

protected void updateEntityAndSendChangeEvents(E entity,
                                               Set<FieldChange> fieldChanges,
                                               boolean notifyProvider)

notifyProviders

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

Specified by:

notifyProviders in class BaseEntityService<T extends EntityId,P extends Id,E extends DomainObject<T,D,P>,EB extends DomainObject.DomainObjectBuilder<T,D,P,E,EB>,Q extends DomainObjectQuery,QB extends EntityQuery.EntityQueryBuilder<Q,QB>,OC extends DomainObjectOperandContainer<T,D,P>,W extends DomainObjectModification<T,D,P,E,EB>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,EB,W,WB>,A extends DomainObjectActionEvent<E,WB>,L extends DomainObjectActionListener<A>,M extends DomainObjectManager<T,D,P,E,EB,Q,QB,OC,W,WB>,PROV extends DomainObjectProvider<T,D,P,?,?>,PERS extends EntityPersistence<T,E,Q>>