com.edorasware.commons.core.any

Interface AnyWorkObjectService

All Superinterfaces:

DomainObjectService<WorkObjectId,WorkObjectDefinitionId,AnyWorkObjectProviderId,AnyWorkObject,AnyWorkObjectQuery,AnyWorkObjectModification,AnyWorkObjectModification.Builder,AnyWorkObjectUpdate,AnyWorkObjectUpdate.Builder>, EntityService<WorkObjectId,AnyWorkObjectProviderId,AnyWorkObject,AnyWorkObjectQuery>, Service, WorkObjectService<WorkObjectId,WorkObjectDefinitionId,AnyWorkObjectProviderId,AnyWorkObject,AnyWorkObjectQuery,AnyWorkObjectModification,AnyWorkObjectModification.Builder,AnyWorkObjectUpdate,AnyWorkObjectUpdate.Builder>

public interface AnyWorkObjectService
extends WorkObjectService<WorkObjectId,WorkObjectDefinitionId,AnyWorkObjectProviderId,AnyWorkObject,AnyWorkObjectQuery,AnyWorkObjectModification,AnyWorkObjectModification.Builder,AnyWorkObjectUpdate,AnyWorkObjectUpdate.Builder>

The service to access the concrete work object management functionality.

Method Summary

Modifier and Type	Method and Description
WorkObjectId	addWorkObject(AnyWorkObject anyWorkObject, String description) Adds the given ad-hoc concrete work object.
WorkObjectId	addWorkObject(AnyWorkObject anyWorkObject, WorkObjectId parentId, String description) Adds the given ad-hoc concrete work object under the given parent.
void	completeWorkObject(WorkObjectId id, String description) Completes the specified concrete work object by setting its state to WorkObjectState.COMPLETED.
long	countWorkObjects(AnyWorkObjectQuery query) Counts the concrete work objects that match the given query.
long	countWorkObjects(AnyWorkObjectQuery query, SearchScope searchScope) Counts the concrete work objects that match the given query.
long	countWorkObjects(Predicate predicate) Counts the concrete work objects that match the query with the given predicate.
long	countWorkObjects(Predicate predicate, SearchScope searchScope) Counts the concrete work objects that match the query with the given predicate.
void	deleteWorkObject(AnyWorkObjectId workObjectId, String description) Deletes the given entity with all its variables.
AnyWorkObject	findWorkObject(AnyWorkObjectQuery query) Finds the concrete work object that matches the given query.
AnyWorkObject	findWorkObject(AnyWorkObjectQuery query, SearchScope searchScope) Finds the concrete work object that matches the given query.
AnyWorkObject	findWorkObject(Predicate predicate) Finds the concrete work object that matches the query with the given predicate.
AnyWorkObject	findWorkObject(Predicate predicate, SearchScope searchScope) Finds the concrete work object that matches the query with the given predicate.
AnyWorkObject	findWorkObjectByExternalId(WorkObjectId externalId) Finds the concrete work object with the given external id.
AnyWorkObject	findWorkObjectByExternalId(WorkObjectId externalId, SearchScope searchScope) Finds the concrete work object with the given external id in the given scope.
AnyWorkObject	findWorkObjectByGlobalId(GlobalId globalId) Finds the concrete work object with the given global id.
AnyWorkObject	findWorkObjectByGlobalId(GlobalId globalId, SearchScope searchScope) Finds the concrete work object with the given global id in the given scope.
AnyWorkObject	findWorkObjectById(WorkObjectId id) Finds the concrete work object with the given concrete work object id.
AnyWorkObject	findWorkObjectById(WorkObjectId id, SearchScope searchScope) Finds the concrete work object with the given concrete work object id in the given scope.
List<AnyWorkObject>	findWorkObjects(AnyWorkObjectQuery query) Finds the concrete work objects that match the given query.
List<AnyWorkObject>	findWorkObjects(AnyWorkObjectQuery query, SearchScope searchScope) Finds the concrete work objects that match the given query.
List<AnyWorkObject>	findWorkObjects(Predicate predicate) Finds the concrete work objects that match the query with the given predicate.
List<AnyWorkObject>	findWorkObjects(Predicate predicate, SearchScope searchScope) Finds the concrete work objects that match the query with the given predicate.
AnyWorkObject	getWorkObjectByGlobalId(GlobalId globalId) Finds the work object with the given global id.
AnyWorkObject	getWorkObjectByGlobalId(GlobalId globalId, SearchScope searchScope) Finds the work object with the given global id in the given scope.
AnyWorkObject	getWorkObjectById(WorkObjectId id) Finds the work object with the given work object id.
AnyWorkObject	getWorkObjectById(WorkObjectId id, SearchScope searchScope) Finds the work object with the given work object id in the given scope.
WorkObjectId	startWorkObject(WorkObjectDefinitionId workObjectDefinitionId) Starts a new concrete work object based on the concrete work object definition with the given id.
WorkObjectId	startWorkObject(WorkObjectDefinitionId workObjectDefinitionId, Map<String,Object> variables) Starts a new work object based on the work object definition with the given id.
WorkObjectId	startWorkObject(WorkObjectDefinitionId definitionId, Map<String,Object> variables, WorkObjectId parentId) Starts a new work object based on the definition with the given id.
WorkObjectId	startWorkObject(WorkObjectDefinitionId definitionId, String name, Object value) Starts a new work object based on the definition with the given id.
WorkObjectId	startWorkObject(WorkObjectDefinitionId definitionId, String name, Object value, WorkObjectId parentId) Starts a new work object based on the definition with the given id.
WorkObjectId	startWorkObject(WorkObjectDefinitionId workObjectDefinitionId, VariableMap variables) Starts a new work object based on the work object definition with the given id.
WorkObjectId	startWorkObject(WorkObjectDefinitionId workObjectDefinitionId, VariableMap variables, WorkObjectId parentId) Starts a new work object based on the work object definition with the given id.
<V> WorkObjectId	startWorkObject(WorkObjectDefinitionId definitionId, VariableName<V,?> name, V value) Starts a new work object based on the definition with the given id.
<V> WorkObjectId	startWorkObject(WorkObjectDefinitionId definitionId, VariableName<V,?> name, V value, WorkObjectId parentId) Starts a new work object based on the definition with the given id.
WorkObjectId	startWorkObject(WorkObjectDefinitionId definitionId, WorkObjectId parentId) Starts a new work object based on the definition with the given id.

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

addEntity, addEntityGeneric, completeEntity, deleteEntity, setAssignedGroup, setAssignedGroup, setAssignedUser, setAssignedUser, setCandidateGroups, setCandidateGroups, setCandidateUsers, setCandidateUsers, setDueTime, setDueTime, setOwner, setOwner, setParent, setParent, setPriority, setPriority, setResubmissionTime, setResubmissionTime, setState, setState, setSubState, setSubState, startEntity, startEntity, startEntity, startEntity, startEntityGeneric

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

apply, createModificationBuilder, createModificationBuilder, createReadableUpdateBuilder, createUpdateBuilder, deleteVariable, deleteVariable, deleteVariable, deleteVariable, deleteVariables, deleteVariables, putVariable, putVariable, putVariable, putVariable, putVariables, putVariables, putVariables, putVariables, setDescription, setDescription, setName, setName, startEntity, startEntity, startEntity, startEntity

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

getWorkObjectById

AnyWorkObject getWorkObjectById(WorkObjectId id)

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

Parameters:

id - the id of the work object to find

Returns:

the matching work object

Throws:

EntityNotFoundException - if work object cannot be found

getWorkObjectById

AnyWorkObject getWorkObjectById(WorkObjectId id,
                                SearchScope searchScope)

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

Parameters:

id - the id of the work object to find

searchScope - the scope in which to search for the work object

Returns:

the matching work object

Throws:

EntityNotFoundException - if work object cannot be found

getWorkObjectByGlobalId

AnyWorkObject getWorkObjectByGlobalId(GlobalId globalId)

Finds the work object with the given global id. If no work object matches the given id, an exception is thrown.

Parameters:

globalId - the global id of the work object to find

Returns:

the matching work object

Throws:

EntityNotFoundException - if work object cannot be found

getWorkObjectByGlobalId

AnyWorkObject getWorkObjectByGlobalId(GlobalId globalId,
                                      SearchScope searchScope)

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

Parameters:

globalId - the global id of the work object to find

searchScope - the scope in which to search for the work object

Returns:

the matching work object

Throws:

EntityNotFoundException - if work object cannot be found

findWorkObjectById

AnyWorkObject findWorkObjectById(WorkObjectId id)

Finds the concrete work object with the given concrete work object id. If no concrete work object matches the given id, null is returned.

Parameters:

id - the id of the concrete work object to find

Returns:

the matching concrete work object

findWorkObjectById

AnyWorkObject findWorkObjectById(WorkObjectId id,
                                 SearchScope searchScope)

Finds the concrete work object with the given concrete work object id in the given scope. If no concrete work object matches the given id, null is returned.

Parameters:

id - the id of the concrete work object to find

searchScope - the scope in which to search for the concrete work object

Returns:

the matching concrete work object

findWorkObjectByGlobalId

AnyWorkObject findWorkObjectByGlobalId(GlobalId globalId)

Finds the concrete work object with the given global id. If no concrete work object matches the given id, null is returned.

Parameters:

globalId - the global id of the work object to find

Returns:

the matching concrete work object

findWorkObjectByGlobalId

AnyWorkObject findWorkObjectByGlobalId(GlobalId globalId,
                                       SearchScope searchScope)

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

Parameters:

globalId - the global id of the work object to find

searchScope - the scope in which to search for the concrete work object

Returns:

the matching concrete work object

findWorkObjectByExternalId

AnyWorkObject findWorkObjectByExternalId(WorkObjectId externalId)

Finds the concrete work object with the given external id. If no concrete work object matches the given external id, null is returned.

Parameters:

externalId - the external id of the concrete work object to find

Returns:

the matching concrete work object

findWorkObjectByExternalId

AnyWorkObject findWorkObjectByExternalId(WorkObjectId externalId,
                                         SearchScope searchScope)

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

Parameters:

externalId - the external id of the concrete work object to find

searchScope - the scope in which to search for the concrete work object

Returns:

the matching concrete work object

findWorkObject

AnyWorkObject findWorkObject(Predicate predicate)

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

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

Parameters:

predicate - the predicate to apply when executing the query

Returns:

the matching concrete work object

findWorkObject

AnyWorkObject findWorkObject(Predicate predicate,
                             SearchScope searchScope)

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

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

Parameters:

predicate - the predicate to apply when executing the query

searchScope - the scope in which to search for the concrete work object

Returns:

the matching concrete work object

findWorkObjects

List<AnyWorkObject> findWorkObjects(Predicate predicate)

Finds the concrete work objects that match the query with the given predicate. If no concrete work object matches the query with the given predicate, an empty list is returned.

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

Parameters:

predicate - the predicate to apply when executing the query

Returns:

the matching concrete work objects

findWorkObjects

List<AnyWorkObject> findWorkObjects(Predicate predicate,
                                    SearchScope searchScope)

Finds the concrete work objects that match the query with the given predicate. If no concrete work object matches the query with the given predicate, an empty list is returned.

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

Parameters:

predicate - the predicate to apply when executing the query

searchScope - the scope in which to search for the concrete work objects

Returns:

the matching concrete work objects

countWorkObjects

long countWorkObjects(Predicate predicate)

Counts the concrete work objects that match the query with the given predicate.

Parameters:

predicate - the predicate to apply when executing the query

Returns:

the number of matching concrete work objects

countWorkObjects

long countWorkObjects(Predicate predicate,
                      SearchScope searchScope)

Counts the concrete work objects that match the query with the given predicate.

Parameters:

predicate - the predicate to apply when executing the query

searchScope - the scope in which to count number of concrete work objects

Returns:

the number of matching concrete work objects

findWorkObject

AnyWorkObject findWorkObject(AnyWorkObjectQuery query)

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

Parameters:

query - the query to execute

Returns:

the matching concrete work object

findWorkObject

AnyWorkObject findWorkObject(AnyWorkObjectQuery query,
                             SearchScope searchScope)

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

Parameters:

query - the query to execute

searchScope - the scope in which to search for the concrete work object

Returns:

the matching concrete work object

findWorkObjects

List<AnyWorkObject> findWorkObjects(AnyWorkObjectQuery query)

Finds the concrete work objects that match the given query. If no concrete work object matches the given query, an empty list is returned.

Parameters:

query - the query to execute

Returns:

the matching concrete work objects

findWorkObjects

List<AnyWorkObject> findWorkObjects(AnyWorkObjectQuery query,
                                    SearchScope searchScope)

Finds the concrete work objects that match the given query. If no concrete work object matches the given query, an empty list is returned.

Parameters:

query - the query to execute

searchScope - the scope in which to search for the concrete work objects

Returns:

the matching concrete work objects

countWorkObjects

long countWorkObjects(AnyWorkObjectQuery query)

Counts the concrete work objects that match the given query.

Parameters:

query - the query to execute

Returns:

the number of matching concrete work objects

countWorkObjects

long countWorkObjects(AnyWorkObjectQuery query,
                      SearchScope searchScope)

Counts the concrete work objects that match the given query.

Parameters:

query - the query to execute

searchScope - the scope in which to count number of concrete work objects

Returns:

the number of matching concrete work objects

addWorkObject

WorkObjectId addWorkObject(AnyWorkObject anyWorkObject,
                           String description)

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

Parameters:

anyWorkObject - the ad-hoc concrete work object to add

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

Returns:

the persisted concrete work object id

See Also:

Entity.getId(), Entity.getExternalId()

addWorkObject

WorkObjectId addWorkObject(AnyWorkObject anyWorkObject,
                           WorkObjectId parentId,
                           String description)

Adds the given ad-hoc concrete work object under the given parent. If the concrete work object's id is undefined, the concrete work object id is generated by the persistence component of the system and guaranteed to be unique. In all other cases, the contributor of the concrete work object needs to ensure that the concrete work object's id is unique.

Parameters:

anyWorkObject - the ad-hoc concrete work object to add

parentId - the parent under which to add the ad-hoc concrete work object

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

Returns:

the persisted concrete work object id

See Also:

Entity.getId(), Entity.getExternalId()

completeWorkObject

void completeWorkObject(WorkObjectId id,
                        String description)

Completes the specified concrete work object by setting its state to WorkObjectState.COMPLETED.

Parameters:

id - the concrete work object to complete

description - transient meta information regarding the reason to complete the concrete work object

Throws:

EntityNotFoundException - if the given concrete work object cannot be found

startWorkObject

WorkObjectId startWorkObject(WorkObjectDefinitionId workObjectDefinitionId)

Starts a new concrete work object based on the concrete work object definition with the given id. Multiple concrete work objects based on the same concrete work object definition can be started and run at the same time. Each running concrete work object can be uniquely identified by its concrete work object id.

Parameters:

workObjectDefinitionId - the id of the concrete work object definition for which to start a new concrete work object

Returns:

the id of the started concrete work object

Throws:

EntityNotFoundException - if the given concrete work object definition cannot be found

startWorkObject

WorkObjectId startWorkObject(WorkObjectDefinitionId definitionId,
                             String name,
                             Object value)

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

Parameters:

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

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

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

Returns:

the id of the started work object

Throws:

EntityNotFoundException - if the given definition cannot be found

startWorkObject

<V> WorkObjectId startWorkObject(WorkObjectDefinitionId definitionId,
                                 VariableName<V,?> name,
                                 V value)

Starts a new work object based on the definition with the given id. The given variable is used to build the initial data set of the work object that is started. Each started work object 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 work object

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

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

Returns:

the id of the started work object

Throws:

EntityNotFoundException - if the given definition cannot be found

startWorkObject

WorkObjectId startWorkObject(WorkObjectDefinitionId workObjectDefinitionId,
                             Map<String,Object> variables)

Starts a new work object based on the work object definition with the given id. The given variables are used to build the initial data set of the work object that is started. Multiple work objects based on the same work object definition can be started and run at the same time. Each running work object can be uniquely identified by its work object id.

Parameters:

workObjectDefinitionId - objectDefinitionId the id of the work object definition for which to start a new work object

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

Returns:

the id of the started work object

Throws:

EntityNotFoundException - if the given work object definition cannot be found

startWorkObject

WorkObjectId startWorkObject(WorkObjectDefinitionId workObjectDefinitionId,
                             VariableMap variables)

Starts a new work object based on the work object definition with the given id. The given variables are used to build the initial data set of the work object that is started. Multiple work objects based on the same work object definition can be started and run at the same time. Each running work object can be uniquely identified by its work object id.

Parameters:

workObjectDefinitionId - objectDefinitionId the id of the work object definition for which to start a new work object

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

Returns:

the id of the started work object

Throws:

EntityNotFoundException - if the given work object definition cannot be found

startWorkObject

WorkObjectId startWorkObject(WorkObjectDefinitionId definitionId,
                             WorkObjectId parentId)

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

Parameters:

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

parentId - the id of the parent work object whose context the work object is started in

Returns:

the id of the started work object

Throws:

EntityNotFoundException - if no definition work object with the given id can be found

startWorkObject

WorkObjectId startWorkObject(WorkObjectDefinitionId definitionId,
                             String name,
                             Object value,
                             WorkObjectId parentId)

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

Parameters:

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

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

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

parentId - the id of the parent work object whose context the work object is started in

Returns:

the id of the started work object

Throws:

EntityNotFoundException - if no definition work object with the given id can be found

startWorkObject

<V> WorkObjectId startWorkObject(WorkObjectDefinitionId definitionId,
                                 VariableName<V,?> name,
                                 V value,
                                 WorkObjectId parentId)

Starts a new work object based on the definition with the given id. The given variable is used to build the initial data set of the work object that is started. Each started work object 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 work object

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

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

parentId - the id of the parent work object whose context the work object is started in

Returns:

the id of the started work object

Throws:

EntityNotFoundException - if no definition work object with the given id can be found

startWorkObject

WorkObjectId startWorkObject(WorkObjectDefinitionId definitionId,
                             Map<String,Object> variables,
                             WorkObjectId parentId)

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

Parameters:

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

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

parentId - the id of the parent work object whose context the work object is started in

Returns:

the id of the started work object

Throws:

EntityNotFoundException - if no definition work object with the given id can be found

startWorkObject

WorkObjectId startWorkObject(WorkObjectDefinitionId workObjectDefinitionId,
                             VariableMap variables,
                             WorkObjectId parentId)

Starts a new work object based on the work object definition with the given id. The given variables are used to build the initial data set of the work object that is started. Multiple work objects based on the same work object definition can be started and run at the same time. Each running work object can be uniquely identified by its work object id.

Parameters:

workObjectDefinitionId - objectDefinitionId the id of the work object definition for which to start a new work object

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

parentId - the id of the parent work object whose context the work object is started in

Returns:

the id of the started work object

Throws:

EntityNotFoundException - if the given work object definition cannot be found

deleteWorkObject

void deleteWorkObject(AnyWorkObjectId workObjectId,
                      String description)

Deletes the given entity with all its variables. If the entity has children then an IllegalArgumentException is thrown such that the path of the children is always valid.

Parameters:

workObjectId - the work object id to delete

description - transient meta information regarding the reason to delete the work object

Throws:

EntityNotFoundException - if no work object with given work object id was found

IllegalArgumentException - if the work object to delete has children.