com.edorasware.commons.core.service.entity

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,?>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,?,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>

All Superinterfaces:

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

All Known Subinterfaces:

AnyWorkObjectService, WorkObjectService<T,D,P,E,Q,W,WB,U,UB>

All Known Implementing Classes:

BaseDomainObjectService, BaseWorkObjectService

public 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,?>,WB extends DomainObjectModification.DomainObjectModificationBuilder<T,D,P,E,?,W,WB>,U extends DomainObjectUpdate<W>,UB extends DomainObjectUpdate.Builder<E,W,WB,U,UB>>
extends EntityService<T,P,E,Q>

Provides generic access to a domain object service.

Method Summary

Modifier and Type	Method and Description
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.
UB	createReadableUpdateBuilder(GlobalId globalId) Creates a new type-safe readable update builder for the given entity.
UB	createUpdateBuilder(GlobalId globalId) Creates a new type-safe update builder for the given entity.
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.
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 id, Map<String,Object> variables, String description) Associates the given variables with the specified entity.
void	putVariables(T id, 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 id, 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 id, 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 id, 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 id, 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.

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

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

init

Method Detail

setName

void setName(T id,
             String name,
             String description)

Sets the name of the specified entity.

Parameters:

id - 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

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

Sets the name of the specified entity.

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

void setDescription(T id,
                    String description,
                    String comment)

Sets the description of the specified entity.

Parameters:

id - 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

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

Sets the description of the specified entity.

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

void setState(T id,
              State state,
              String description)

Sets the state of the specified entity.

Parameters:

id - 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

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

Sets the state of the specified entity.

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

void setSubState(T id,
                 State subState,
                 String description)

Sets the sub state of the specified entity.

Parameters:

id - 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

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

Sets the sub state of the specified entity.

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

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

Associates the given variable with the specified entity.

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

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

Associates the given variable with the specified entity.

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

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

Associates the given variable with the specified entity.

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

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

Associates the given variable with the specified entity.

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

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

Associates the given variables with the specified entity.

Parameters:

id - 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

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

Associates the given variables with the specified entity.

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

void putVariables(T id,
                  VariableMap variables,
                  String description)

Associates the given variables with the specified entity.

Parameters:

id - 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

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

Associates the given variables with the specified entity.

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

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

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.

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

Throws:

EntityNotFoundException - if the given entity cannot be found

deleteVariable

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

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.

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

Throws:

EntityNotFoundException - if the given entity cannot be found

deleteVariable

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

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.

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

Throws:

EntityNotFoundException - if the given entity cannot be found

deleteVariable

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

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.

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

Throws:

EntityNotFoundException - if the given entity cannot be found

deleteVariables

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

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.

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

Throws:

EntityNotFoundException - if the given entity cannot be found

deleteVariables

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

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.

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

Throws:

EntityNotFoundException - if the given entity cannot be found

startEntity

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

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.

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

Throws:

EntityNotFoundException - if the given definition cannot be found

startEntity

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

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.

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

Throws:

EntityNotFoundException - if the given definition cannot be found

startEntity

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

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.

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

Throws:

EntityNotFoundException - if the given definition cannot be found

startEntity

T startEntity(D definitionId,
              VariableMap variables)

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.

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

Throws:

EntityNotFoundException - if the given definition cannot be found

createModificationBuilder

WB createModificationBuilder()

Creates a new type-safe modification builder.

Returns:

the type-safe modification builder

createModificationBuilder

WB createModificationBuilder(W modification)

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

Parameters:

modification - the template modification

Returns:

the type-safe modification builder

createUpdateBuilder

UB createUpdateBuilder(GlobalId globalId)

Creates a new type-safe update builder for the given entity.

Parameters:

globalId - the global id

Returns:

the type-safe update builder

createReadableUpdateBuilder

UB createReadableUpdateBuilder(GlobalId globalId)

Creates a new type-safe readable update builder for the given entity.

Parameters:

globalId - the global id

Returns:

the type-safe readable update builder

apply

E apply(U update,
        String description)

Applies an entity update.

Parameters:

update - the update to be applied

description - transient meta information regarding the reason for the change

Returns:

the updated entity