com.edorasware.commons.core.any

Interface AnyWorkObjectService

All Superinterfaces:

EntityService<AnyWorkObject>

All Known Implementing Classes:

DefaultAnyWorkObjectService

public interface AnyWorkObjectService
extends EntityService<AnyWorkObject>

The service to access the concrete work object management functionality.

Method Summary

Modifier and Type	Method and Description
AnyWorkObject	apply(GearWorkObjectUpdate update, String description) Applies an entity update.
void	cancelEntity(String entityId) Cancels or terminates any background activities / processes associated with the given work object.
void	completeEntity(String id, String description) Completes the given entity by setting its state to WorkObjectState.STATE_COMPLETED.
void	completeWorkObject(String id, String description) Completes the specified concrete work object by setting its state to WorkObjectState.STATE_COMPLETED.
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.
long	countWorkObjects(Query query) Counts the concrete work objects that match the given query.
long	countWorkObjects(Query query, SearchScope searchScope) Counts the concrete work objects that match the given query.
String	create(String definitionId) Creates a new root entity based on the given definition ID.
String	create(String definitionId, String parentId) Creates a new child entity based on the given definition ID.
AnyWorkObjectModification.Builder	createModificationBuilder() Creates a new type-safe modification builder.
GearWorkObjectUpdate.Builder	createUpdateBuilder(String workObjectId) Creates a new type-safe update builder for the given entity.
void	deleteEntity(String entityId, String description) Deletes the given entity with all its variables.
void	deleteVariable(String id, String name, String description) Deletes the variable with the given name from the entity with given id.
<V> void	deleteVariable(String id, ValueAccessor<V> name, String description) Deletes the variable with the given name from the entity with given id.
void	deleteVariables(String entityId, Collection<String> variables, String description) Deletes the variables from the collection of variable names from the entity with given entityId.
void	deleteWorkObject(String workObjectId, String description) Deletes the given entity with all its variables.
String	findParentId(AnyWorkObject workObject) Returns the parent work object.
String	findParentIdByType(AnyWorkObject workObject, String requiredType) Returns the closest parent work object of the given type for a given work object.
String	findTopMostParentIdByType(AnyWorkObject workObject, String requiredType, boolean includeSelf) Returns the top-most parent work object of the given type for a given work object.
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	findWorkObject(Query query) Finds the concrete work object that matches the given query.
AnyWorkObject	findWorkObject(Query query, SearchScope searchScope) Finds the concrete work object that matches the given query.
AnyWorkObject	findWorkObjectByExternalId(String externalId) Finds the concrete work object with the given external id.
AnyWorkObject	findWorkObjectByExternalId(String externalId, SearchScope searchScope) Finds the concrete work object with the given external id in the given scope.
AnyWorkObject	findWorkObjectByGlobalId(String globalId) Finds the concrete work object with the given global id.
AnyWorkObject	findWorkObjectByGlobalId(String globalId, SearchScope searchScope) Finds the concrete work object with the given global id in the given scope.
AnyWorkObject	findWorkObjectById(String id) Finds the concrete work object with the given concrete work object id.
AnyWorkObject	findWorkObjectById(String id, SearchScope searchScope) Finds the concrete work object with the given concrete work object id in the given scope.
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.
List<AnyWorkObject>	findWorkObjects(Query query) Finds the concrete work objects that match the given query.
List<AnyWorkObject>	findWorkObjects(Query query, SearchScope searchScope) Finds the concrete work objects that match the given query.
String	getRootId(AnyWorkObject workObject) Returns the root work object ID for a given work object.
<V> V	getServiceInterface(String providerId, Class<V> serviceInterfaceClass) Returns the typed service interface for a given provider ID.
<V> List<V>	getServiceInterfaces(Class<V> serviceInterfaceClass) Returns all instances of a typed service interface for the current providers.
AnyWorkObject	getWorkObjectByGlobalId(String globalId) Finds the work object with the given global id.
AnyWorkObject	getWorkObjectByGlobalId(String globalId, SearchScope searchScope) Finds the work object with the given global id in the given scope.
AnyWorkObject	getWorkObjectById(String id) Finds the work object with the given work object id.
AnyWorkObject	getWorkObjectById(String id, SearchScope searchScope) Finds the work object with the given work object id in the given scope.
void	putVariable(String id, String name, Object value, String description) Associates the given variable with the specified entity.
<V> void	putVariable(String id, ValueAccessor<V> name, V value, String description) Associates the given variable with the specified entity.
void	putVariables(String id, Map<String,Object> variables, String description) Associates the given variables with the specified entity.
void	putVariables(String id, ValueMap variables, String description) Associates the given variables with the specified entity.
void	setAssignedGroup(String id, String groupId, String description) Sets the user to which the specified entity is assigned to.
void	setAssignedUser(String id, String userId, String description) Sets the user to which the specified entity is assigned to.
void	setCandidateGroups(String id, Set<String> groupIds, String description) Sets the candidate groups of the specified entity.
void	setCandidateUsers(String id, Set<String> userIds, String description) Sets the candidate users of the specified entity.
void	setDueTime(String id, Instant dueTime, String description) Sets the due time of the specified entity.
void	setName(String id, String name, String description) Sets the name of the specified entity.
void	setOwner(String id, String userId, String description) Sets the owner of the specified entity.
void	setParent(String id, String parentId, String description) Sets the parent of the specified entity.
void	setPriority(String id, Integer priority, String description) Sets the priority of the specified entity.
void	setResubmissionTime(String id, Instant resubmissionTime, String description) Sets the resubmission time of the specified entity.
void	setState(String id, String state, String description) Sets the WorkObjectState of the specified entity.
void	setSubState(String id, String state, String description) Sets the WorkObjectState of the specified entity.

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

countEntities, countEntities, countEntities, countEntities, create, create, findEntities, findEntities, findEntities, findEntities, findEntity, findEntity, findEntity, findEntity, findEntityByExternalId, findEntityByExternalId, findEntityByGlobalId, findEntityByGlobalId, findEntityById, findEntityById, findIdByExternalId, findIdByExternalId, getEntityByGlobalId, getEntityByGlobalId, getEntityById, getEntityById

Method Detail

getWorkObjectById

AnyWorkObject getWorkObjectById(String 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(String 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(String 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(String 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(String 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(String 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(String 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(String 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(String 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(String 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. <p> 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. <p> 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. <p> 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. <p> 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(Query 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(Query 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(Query 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(Query 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(Query 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(Query 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

completeWorkObject

void completeWorkObject(String id,
                        String description)

Completes the specified concrete work object by setting its state to WorkObjectState.STATE_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

deleteWorkObject

void deleteWorkObject(String 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.

findParentId

String findParentId(AnyWorkObject workObject)

Returns the parent work object.

Returns:

the parent work object or null if the work object has no parent

findParentIdByType

String findParentIdByType(AnyWorkObject workObject,
                          String requiredType)

Returns the closest parent work object of the given type for a given work object.

Parameters:

workObject - the work object

requiredType - the required work object type

Returns:

the parent work object or null if there was no match

findTopMostParentIdByType

String findTopMostParentIdByType(AnyWorkObject workObject,
                                 String requiredType,
                                 boolean includeSelf)

Returns the top-most parent work object of the given type for a given work object.

Parameters:

workObject - the work object

requiredType - the required work object type

includeSelf - true if the starting work object should be included in the search

Returns:

the parent work object or null if there was no match

getRootId

String getRootId(AnyWorkObject workObject)

Returns the root work object ID for a given work object.

Parameters:

workObject - the starting work object

Returns:

the root work object ID (may be the ID work object itself if there is no parent).

getServiceInterface

<V> V getServiceInterface(String providerId,
                          Class<V> serviceInterfaceClass)

Returns the typed service interface for a given provider ID.

Type Parameters:

V - the type of the required service interface

Parameters:

providerId - the provider ID

serviceInterfaceClass - the required service interface class

Returns:

the service interface instance

Throws:

IllegalStateException - if no matching provider is found

ClassCastException - if the actual provider has the wrong type

getServiceInterfaces

<V> List<V> getServiceInterfaces(Class<V> serviceInterfaceClass)

Returns all instances of a typed service interface for the current providers.

Type Parameters:

V - the type of the required service interface

Parameters:

serviceInterfaceClass - the required service interface class

Returns:

the service interfaces

setState

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

Sets the WorkObjectState of the specified entity.

Parameters:

id - the id of the entity for which to set the work object state

state - the work object state to set on the entity

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

setSubState

void setSubState(String id,
                 String state,
                 String description)

Sets the WorkObjectState of the specified entity.

Parameters:

id - the id of the entity for which to set the work object sub-state

state - the work object sub-state to set on the entity

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

setOwner

void setOwner(String id,
              String userId,
              String description)

Sets the owner of the specified entity.

Parameters:

id - the entity to own

userId - the user whom to give ownership of the entity

description - transient meta information regarding the reason to give ownership of the entity

Throws:

EntityNotFoundException - if the given entity cannot be found

setAssignedUser

void setAssignedUser(String id,
                     String userId,
                     String description)

Sets the user to which the specified entity is assigned to.

Parameters:

id - the entity to assign to a user

userId - the user whom to assign the entity to

description - transient meta information regarding the reason to assign the entity to a user

Throws:

EntityNotFoundException - if no entity with the given id can be found

setAssignedGroup

void setAssignedGroup(String id,
                      String groupId,
                      String description)

Sets the user to which the specified entity is assigned to.

Parameters:

id - the entity to assign to a group

groupId - the group whom to assign the entity to

description - transient meta information regarding the reason to assign the entity to a group

Throws:

EntityNotFoundException - if no entity with the given id can be found

setCandidateUsers

void setCandidateUsers(String id,
                       Set<String> userIds,
                       String description)

Sets the candidate users of the specified entity.

Parameters:

id - the entity for which to set the candidate users

userIds - the candidate users

description - transient meta information regarding the reason to set the candidate users

Throws:

EntityNotFoundException - if no entity with the given id can be found

setCandidateGroups

void setCandidateGroups(String id,
                        Set<String> groupIds,
                        String description)

Sets the candidate groups of the specified entity.

Parameters:

id - the entity for which to set the candidate groups

groupIds - the candidate groups

description - transient meta information regarding the reason to set the candidate groups

Throws:

EntityNotFoundException - if no entity with the given id can be found

setPriority

void setPriority(String id,
                 Integer priority,
                 String description)

Sets the priority of the specified entity.

Parameters:

id - the id of the entity for which to set the priority

priority - the priority to set on the entity

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

Throws:

EntityNotFoundException - if no entity with the given id can be found

setResubmissionTime

void setResubmissionTime(String id,
                         Instant resubmissionTime,
                         String description)

Sets the resubmission time of the specified entity.

Parameters:

id - the id of the entity for which to set the resubmission time

resubmissionTime - the resubmission time to set on the entity

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

Throws:

EntityNotFoundException - if no entity with the given id can be found

setDueTime

void setDueTime(String id,
                Instant dueTime,
                String description)

Sets the due time of the specified entity.

Parameters:

id - the id of the entity for which to set the due time

dueTime - the due time to set on the entity

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

Throws:

EntityNotFoundException - if no entity with the given id can be found

setParent

void setParent(String id,
               String parentId,
               String description)

Sets the parent of the specified entity.

Note that this will move the current work object and all of its descendants to the new parent. Special care is needed when the descendants contain running processes. If a running process accesses state in its parent work objects then changing the process parent (or grandparent etc.) may mean that the subsequent process execution could behave incorrectly.

Parameters:

id - the id of the entity for which to set the parent

parentId - the parent to set on the entity

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

Throws:

EntityNotFoundException - if no entity with the given id can be found

completeEntity

void completeEntity(String id,
                    String description)

Completes the given entity by setting its state to WorkObjectState.STATE_COMPLETED.

Parameters:

id - the entity to complete

description - transient meta information regarding the reason to complete the entity

Throws:

EntityNotFoundException - if no entity with the given id can be found

deleteEntity

void deleteEntity(String entityId,
                  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:

entityId - the entity 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.

cancelEntity

void cancelEntity(String entityId)

Cancels or terminates any background activities / processes associated with the given work object.

If no background activity is present then this method will have no effect.

Parameters:

entityId - the work object to be cancelled

create

String create(String definitionId)

Creates a new root entity based on the given definition ID.

The definition provider will be used to manage the entity creation.

Parameters:

definitionId - the definition ID

Returns:

the new entity ID

create

String create(String definitionId,
              String parentId)

Creates a new child entity based on the given definition ID.

The definition provider will be used to manage the entity creation.

Parameters:

definitionId - the definition ID

Returns:

the new entity ID

setName

void setName(String 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

putVariable

void putVariable(String 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

<V> void putVariable(String id,
                     ValueAccessor<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

putVariables

void putVariables(String 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(String id,
                  ValueMap 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

deleteVariable

void deleteVariable(String 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

<V> void deleteVariable(String id,
                        ValueAccessor<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

deleteVariables

void deleteVariables(String 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

createModificationBuilder

AnyWorkObjectModification.Builder createModificationBuilder()

Creates a new type-safe modification builder.

Returns:

the type-safe modification builder

createUpdateBuilder

GearWorkObjectUpdate.Builder createUpdateBuilder(String workObjectId)

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

Parameters:

workObjectId - the work object ID

Returns:

the type-safe update builder

apply

AnyWorkObject apply(GearWorkObjectUpdate 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