Package org.bonitasoft.engine.core.process.instance.impl

Class ActivityInstanceServiceImpl

java.lang.Object

org.bonitasoft.engine.core.process.instance.impl.FlowNodeInstancesServiceImpl

org.bonitasoft.engine.core.process.instance.impl.ActivityInstanceServiceImpl

All Implemented Interfaces:

ActivityInstanceService, FlowNodeInstanceService

public class ActivityInstanceServiceImpl
extends FlowNodeInstancesServiceImpl
implements ActivityInstanceService

Author:

Elias Ricken de Medeiros, Matthieu Chaffotte, Hongwen Zang, Emmanuel Duchastenier, Yanyan Liu, Baptiste Mesta, Celine Souchet

Field Summary

Fields inherited from interface org.bonitasoft.engine.core.process.instance.api.ActivityInstanceService

ACTIVITYINSTANCE, PENDINGACTIVITYMAPPING

Fields inherited from interface org.bonitasoft.engine.core.process.instance.api.FlowNodeInstanceService

ACTIVITY_INSTANCE_TOKEN_COUNT, ACTIVITYINSTANCE_DISPLAY_DESCRIPTION, ACTIVITYINSTANCE_DISPLAY_NAME, ACTIVITYINSTANCE_STATE, EXECUTED_BY_MODIFIED, EXECUTED_BY_SUBSTITUTE_MODIFIED, EXPECTED_END_DATE_MODIFIED, FLOWNODE_INSTANCE, LOOPINSTANCE_LOOPMAX_MODIFIED, MULTIINSTANCE_LOOPCARDINALITY_MODIFIED, MULTIINSTANCE_NUMBEROFINSTANCE_MODIFIED, STATE_CATEGORY

Constructor Summary

Constructors

Constructor	Description
ActivityInstanceServiceImpl(Recorder recorder, PersistenceService persistenceService, ArchiveService archiveService)

Method Summary

Modifier and Type	Method	Description
void	addMultiInstanceNumberOfActiveActivities(SMultiInstanceActivityInstance flowNodeInstance, int number)	Add number of activeInstances for the specific SMultiInstanceActivityInstance object
void	addMultiInstanceNumberOfCompletedActivities(SMultiInstanceActivityInstance flowNodeInstance, int number)	Add number of completed activeInstances for the specific SMultiInstanceActivityInstance object
void	addMultiInstanceNumberOfTerminatedActivities(SMultiInstanceActivityInstance flowNodeInstance, int number)	Add number of terminated activeInstances for the specific SMultiInstanceActivityInstance object
void	addPendingActivityMappings(SPendingActivityMapping mapping)	Create a new pending activity mapping in DB
void	assignHumanTask(long userTaskId, long userId)	Assign the specific human task to the user
void	assignHumanTaskIfNotAssigned(long userTaskId, long userId)	Assign the specific human task to the user if it is not currently assigned
void	createActivityInstance(SActivityInstance activityInstance)	Create activityInstance in DB according to the given activityInstance object
void	deleteAllPendingMappings()	Delete all pending mappings for the connected tenant
void	deletePendingMappings(long humanTaskInstanceId)	deletePendingMappings
List<SActivityInstance>	getActivitiesWithStates(long rootContainerId, Set<Integer> stateIds, int fromIndex, int maxResults, String sortingField, OrderByType sortingOrder)	Get activities with specific states in the root container in specific order, this is used for pagination
SActivityInstance	getActivityInstance(long activityInstanceId)	Get activityInstance by its id
List<SActivityInstance>	getActivityInstances(long rootContainerId, int fromIndex, int numberOfResults)	Get all activity instances for the specific process instance
SAActivityInstance	getArchivedActivityInstance(long activityInstanceId, int stateId)	Gets the archive instance of the activity according to its identifier at a given state.
List<SAActivityInstance>	getArchivedActivityInstances(long rootContainerId, QueryOptions queryOptions)	Get archived activity instances in the specific root container.
List<SHumanTaskInstance>	getAssignedUserTasks(long assigneeId, int fromIndex, int maxResults, String sortFieldName, OrderByType order)	Get tasks assigned to the user.
List<SActivityInstance>	getChildrenOfAnActivity(long parentActivityInstanceId, int fromIndex, int numberOfResults)	Get all child instances for the specific parent activity instance, order by id ascending.
SHumanTaskInstance	getHumanTaskInstance(long activityInstanceId)	Get humanTaskInstance by its id
SAActivityInstance	getMostRecentArchivedActivityInstance(long activityInstanceId)	Get the most recent archived version of a specified activity instance
long	getNumberOfActivityInstances(Class<? extends PersistentObject> entityClass, QueryOptions searchOptions)	Get total number of activity instances for the specific entity class
long	getNumberOfArchivedActivityInstances(Class<? extends PersistentObject> entityClass, QueryOptions searchOptions)	Get total number of archived activity instances for the specific entity class
long	getNumberOfArchivedHumanTasksSupervisedBy(long supervisorId, QueryOptions queryOptions)	Search AUserTask instances archived for a specific supervisor
long	getNumberOfArchivedTasks(QueryOptions searchOptions)	Get total number of archived tasks according to specific search criteria
long	getNumberOfArchivedTasksManagedBy(long managerUserId, QueryOptions searchOptions)	get the total number of archived tasks assigned to subordinates of specified manager.
long	getNumberOfAssignedAndPendingHumanTasks(long rootProcessDefinitionId, QueryOptions queryOptions)	Get the total number of the assigned and pending human tasks for any user, on the specified root process definition, corresponding to the options.
long	getNumberOfAssignedAndPendingHumanTasks(QueryOptions queryOptions)	Get the total number of the assigned and pending human tasks for any user corresponding to the options.
long	getNumberOfAssignedAndPendingHumanTasksFor(long rootProcessDefinitionId, long userId, QueryOptions queryOptions)	Get the total number of the assigned and pending human tasks for the specified user, on the specified root process definition, corresponding to the options.
long	getNumberOfAssignedHumanTaskInstances(long userId)	Get the number of UserTask instances assigned to a specific user
long	getNumberOfAssignedTasksManagedBy(long managerUserId, QueryOptions searchOptions)	Get total number of assigned tasks managed by the specific manager
long	getNumberOfAssignedTasksSupervisedBy(long supervisorId, QueryOptions queryOptions)	Search UserTask instances assigned for a specific supervisor
long	getNumberOfHumanTasks(QueryOptions queryOptions)	Get number of human task instances according to the criteria
int	getNumberOfOpenActivityInstances(long rootContainerId)	Get total number of open activity instances for the specific process instance
Map<Long,Long>	getNumberOfOpenTasksForUsers(List<Long> userIds)	Get number of open tasks for each user
Map<Long,Long>	getNumberOfOverdueOpenTasksForUsers(List<Long> userIds)	Get number of overdue open tasks for each user
long	getNumberOfPendingOrAssignedOrAssignedToOthersTasks(long userId, QueryOptions searchOptions)
long	getNumberOfPendingOrAssignedTasks(long userId, QueryOptions searchOptions)
long	getNumberOfPendingTasksAssignedTo(long userId, QueryOptions searchOptions)
long	getNumberOfPendingTasksForUser(long userId, QueryOptions searchOptions)
long	getNumberOfPendingTasksSupervisedBy(long supervisorId, QueryOptions queryOptions)	Get total number of pending human task instances for the specific supervisor
long	getNumberOfUsersWhoCanExecutePendingHumanTaskDeploymentInfo(long humanTaskInstanceId, QueryOptions searchOptions)	Get total number of users according to specific query options, and who can start the task filtered with the search option of the given process definition
List<SActivityInstance>	getOpenActivityInstances(long rootContainerId, int pageIndex, int maxResults, String sortingField, OrderByType orderbyType)	Get all open activity instances in the specific process instance.
List<SPendingActivityMapping>	getPendingMappings(long humanTaskInstanceId, QueryOptions queryOptions)
List<SHumanTaskInstance>	getPendingTasks(long userId, Set<Long> actorIds, int fromIndex, int maxResults, String sortFieldName, OrderByType order)	Get pending tasks for the user in specific actors.
List<Long>	getPossibleUserIdsOfPendingTasks(long humanTaskInstanceId, int startIndex, int maxResults)
void	incrementLoopCounter(SLoopActivityInstance loopInstance)	Increase loopCounter(loopCount+1) for the specific loop instance
boolean	isTaskPendingForUser(long humanTaskInstanceId, long userId)
List<SActivityInstance>	searchActivityInstances(Class<? extends PersistentObject> entityClass, QueryOptions searchOptions)	Search all activity instances for the specific entity class
List<SAActivityInstance>	searchArchivedActivityInstances(Class<? extends PersistentObject> entityClass, QueryOptions searchOptions)	Search all archived activity instances for the specific entity class
List<SAHumanTaskInstance>	searchArchivedHumanTasksSupervisedBy(long supervisorId, QueryOptions queryOptions)	Search AUserTask instances archived for a specific supervisor
List<SAHumanTaskInstance>	searchArchivedTasks(QueryOptions searchOptions)	Search archived human tasks according to specific search criteria
List<SAHumanTaskInstance>	searchArchivedTasksManagedBy(long managerUserId, QueryOptions searchOptions)	get the archived tasks assigned to subordinates of specified manager, limited to, sorted, paginated with the specifies QueryOptions
List<SHumanTaskInstance>	searchAssignedAndPendingHumanTasks(long rootProcessDefinitionId, QueryOptions queryOptions)	Search the assigned and pending human tasks for any user, on the specified root process definition, corresponding to the options.
List<SHumanTaskInstance>	searchAssignedAndPendingHumanTasks(QueryOptions queryOptions)	Search the assigned and pending human tasks for any user corresponding to the options.
List<SHumanTaskInstance>	searchAssignedAndPendingHumanTasksFor(long rootProcessDefinitionId, long userId, QueryOptions queryOptions)	Search the assigned and pending human tasks for the specified user, on the specified root process definition, corresponding to the options.
List<SHumanTaskInstance>	searchAssignedTasksManagedBy(long managerUserId, QueryOptions searchOptions)	Get all assigned tasks managed by the specific manager
List<SHumanTaskInstance>	searchAssignedTasksSupervisedBy(long supervisorId, QueryOptions queryOptions)	Search UserTask instances assigned for a specific supervisor
List<SHumanTaskInstance>	searchHumanTasks(QueryOptions queryOptions)	Search all human task instances according to the criteria
long	searchNumberOfPendingTasksManagedBy(long managerUserId, QueryOptions searchOptions)	Search total number of pending tasks for the specific manager
List<SHumanTaskInstance>	searchPendingOrAssignedOrAssignedToOthersTasks(long userId, QueryOptions searchOptions)
List<SHumanTaskInstance>	searchPendingOrAssignedTasks(long userId, QueryOptions searchOptions)
List<SHumanTaskInstance>	searchPendingTasksAssignedTo(long userId, QueryOptions searchOptions)
List<SHumanTaskInstance>	searchPendingTasksForUser(long userId, QueryOptions searchOptions)
List<SHumanTaskInstance>	searchPendingTasksManagedBy(long managerUserId, QueryOptions searchOptions)	Search all pending tasks for the specific manager
List<SHumanTaskInstance>	searchPendingTasksSupervisedBy(long supervisorId, QueryOptions queryOptions)	Search all pending human task instances for the specific supervisor
List<SUser>	searchUsersWhoCanExecutePendingHumanTaskDeploymentInfo(long humanTaskInstanceId, QueryOptions searchOptions)	Search the users according to specific query options, and who can start the task filtered with the search option of the given process definition
void	setAbortedByBoundaryEvent(SActivityInstance activityInstance, long boundaryEventId)
void	setLoopCardinality(SFlowNodeInstance flowNodeInstance, int intLoopCardinality)	Set LoopCardinality for the specific loopActvity
void	setLoopMax(SLoopActivityInstance loopActivity, Integer loopMap)	Set max loop for the specific loopActvity
void	setTokenCount(SActivityInstance activityInstance, int tokenCount)	Set tokenCount for the specific activity instance

Methods inherited from class org.bonitasoft.engine.core.process.instance.impl.FlowNodeInstancesServiceImpl

deleteArchivedFlowNodeInstances, deleteFlowNodeInstance, getAllChildrenOfProcessInstance, getArchivedFlowNodeInstance, getArchivedFlowNodeInstances, getArchiveService, getDirectChildrenOfActivityInstance, getDirectChildrenOfProcessInstance, getFlowNodeInstance, getFlowNodeInstanceIdsToRecover, getFlowNodeInstancesByIds, getFlowNodeInstancesByNameAndParentContainerId, getGatewayInstanceIdsToRecover, getLastArchivedFlowNodeInstance, getNumberOfArchivedFlowNodeInstances, getNumberOfArchivedFlowNodeInstancesSupervisedBy, getNumberOfArchivedFlownodesInAllStates, getNumberOfFlowNodeInstances, getNumberOfFlowNodeInstancesSupervisedBy, getNumberOfFlowNodes, getNumberOfFlownodesInAllStates, getNumberOfFlownodesOfProcessDefinitionInAllStates, getPersistenceService, getRecorder, getSourceObjectIdsOfArchivedFlowNodeInstances, getUnmodifiableList, searchArchivedFlowNodeInstances, searchArchivedFlowNodeInstancesSupervisedBy, searchFlowNodeInstances, searchFlowNodeInstancesSupervisedBy, setExecutedBy, setExecutedBySubstitute, setExecuting, setExpectedEndDate, setState, setStateCategory, setTaskPriority, updateDisplayDescription, updateDisplayName, updateFlowNode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bonitasoft.engine.core.process.instance.api.FlowNodeInstanceService

deleteArchivedFlowNodeInstances, deleteFlowNodeInstance, getAllChildrenOfProcessInstance, getArchivedFlowNodeInstance, getArchivedFlowNodeInstances, getDirectChildrenOfActivityInstance, getDirectChildrenOfProcessInstance, getFlowNodeInstance, getFlowNodeInstanceIdsToRecover, getFlowNodeInstancesByIds, getFlowNodeInstancesByNameAndParentContainerId, getGatewayInstanceIdsToRecover, getLastArchivedFlowNodeInstance, getNumberOfArchivedFlowNodeInstances, getNumberOfArchivedFlowNodeInstancesSupervisedBy, getNumberOfArchivedFlownodesInAllStates, getNumberOfFlowNodeInstances, getNumberOfFlowNodeInstancesSupervisedBy, getNumberOfFlowNodes, getNumberOfFlownodesInAllStates, getNumberOfFlownodesOfProcessDefinitionInAllStates, getSourceObjectIdsOfArchivedFlowNodeInstances, searchArchivedFlowNodeInstances, searchArchivedFlowNodeInstancesSupervisedBy, searchFlowNodeInstances, searchFlowNodeInstancesSupervisedBy, setExecutedBy, setExecutedBySubstitute, setExecuting, setExpectedEndDate, setState, setStateCategory, setTaskPriority, updateDisplayDescription, updateDisplayName

Constructor Details

ActivityInstanceServiceImpl

public ActivityInstanceServiceImpl(Recorder recorder,
 PersistenceService persistenceService,
 ArchiveService archiveService)

Method Details

createActivityInstance

public void createActivityInstance(SActivityInstance activityInstance)
                            throws SActivityCreationException

Description copied from interface: ActivityInstanceService

Create activityInstance in DB according to the given activityInstance object

Specified by:

createActivityInstance in interface ActivityInstanceService

Parameters:

activityInstance - an SActivityInstance object

Throws:

SActivityCreationException

addPendingActivityMappings

public void addPendingActivityMappings(SPendingActivityMapping mapping)
                                throws SActivityCreationException

Description copied from interface: ActivityInstanceService

Create a new pending activity mapping in DB

Specified by:

addPendingActivityMappings in interface ActivityInstanceService

Parameters:

mapping - pending activity mapping object

Throws:

SActivityCreationException

deletePendingMappings

public void deletePendingMappings(long humanTaskInstanceId)
                           throws SActivityModificationException

Description copied from interface: ActivityInstanceService

deletePendingMappings

Specified by:

deletePendingMappings in interface ActivityInstanceService

Throws:

SActivityModificationException

deleteAllPendingMappings

public void deleteAllPendingMappings()
                              throws SActivityModificationException

Description copied from interface: ActivityInstanceService

Delete all pending mappings for the connected tenant

Specified by:

deleteAllPendingMappings in interface ActivityInstanceService

Throws:

SActivityModificationException

getPendingMappings

public List<SPendingActivityMapping> getPendingMappings(long humanTaskInstanceId,
 QueryOptions queryOptions)
                                                 throws SBonitaReadException

Specified by:

getPendingMappings in interface ActivityInstanceService

Parameters:

humanTaskInstanceId -

queryOptions -

Returns:

Throws:

SBonitaReadException

getActivityInstance

public SActivityInstance getActivityInstance(long activityInstanceId)
                                      throws SActivityInstanceNotFoundException,
SActivityReadException

Description copied from interface: ActivityInstanceService

Get activityInstance by its id

Specified by:

getActivityInstance in interface ActivityInstanceService

Parameters:

activityInstanceId - identifier of activityInstance

Returns:

an SActivityInstance object with id corresponding to the parameter

Throws:

SActivityInstanceNotFoundException - if no activityInstance found

SActivityReadException

getHumanTaskInstance

public SHumanTaskInstance getHumanTaskInstance(long activityInstanceId)
                                        throws SActivityInstanceNotFoundException,
SActivityReadException

Description copied from interface: ActivityInstanceService

Get humanTaskInstance by its id

Specified by:

getHumanTaskInstance in interface ActivityInstanceService

Parameters:

activityInstanceId - identifier of humanTaskInstance

Returns:

an SHumanTaskInstance object with id corresponding to the parameter

Throws:

SActivityInstanceNotFoundException

SActivityReadException

getActivitiesWithStates

public List<SActivityInstance> getActivitiesWithStates(long rootContainerId,
 Set<Integer> stateIds,
 int fromIndex,
 int maxResults,
 String sortingField,
 OrderByType sortingOrder)
                                                throws SActivityReadException

Description copied from interface: ActivityInstanceService

Get activities with specific states in the root container in specific order, this is used for pagination

Specified by:

getActivitiesWithStates in interface ActivityInstanceService

Parameters:

rootContainerId - identifier of root container, it always is process definition id

stateIds - Identifiers of states

fromIndex - Index of the record to be retrieved from. First record has index 0

maxResults - Number of result we want to get. Maximum number of result returned

sortingField - the field used to do order

sortingOrder - ASC or DESC

Returns:

a list of SActivityInstance objects

Throws:

SActivityReadException

getOpenActivityInstances

public List<SActivityInstance> getOpenActivityInstances(long rootContainerId,
 int pageIndex,
 int maxResults,
 String sortingField,
 OrderByType orderbyType)
                                                 throws SActivityReadException

Description copied from interface: ActivityInstanceService

Get all open activity instances in the specific process instance. This is used for pagination

Specified by:

getOpenActivityInstances in interface ActivityInstanceService

Parameters:

rootContainerId - identifier of root container, the root container can be process instance

pageIndex - the page index to indicate which page will be retrieved. First page has index 0

maxResults - Number of result we want to get. Maximum number of result returned

sortingField - the field used to do order

orderbyType - ASC or DESC

Returns:

a list of SActivityInstance objects

Throws:

SActivityReadException

getMostRecentArchivedActivityInstance

public SAActivityInstance getMostRecentArchivedActivityInstance(long activityInstanceId)
                                                         throws SActivityReadException,
SActivityInstanceNotFoundException

Description copied from interface: ActivityInstanceService

Get the most recent archived version of a specified activity instance

Specified by:

getMostRecentArchivedActivityInstance in interface ActivityInstanceService

Parameters:

activityInstanceId - identifier of activity instance

Returns:

an SAActivityInstance object

Throws:

SActivityReadException - if a Read error occurs

SActivityInstanceNotFoundException - it the provided activityInstanceId does not refer to an existing Activity Instance

getArchivedActivityInstances

public List<SAActivityInstance> getArchivedActivityInstances(long rootContainerId,
 QueryOptions queryOptions)
                                                      throws SActivityReadException

Description copied from interface: ActivityInstanceService

Get archived activity instances in the specific root container.

Specified by:

getArchivedActivityInstances in interface ActivityInstanceService

Parameters:

rootContainerId - identifier of root container, the root container can be process instance

queryOptions - a map of specific parameters of a query

Returns:

a list of SAActivityInstance objects

Throws:

SActivityReadException

getPendingTasks

public List<SHumanTaskInstance> getPendingTasks(long userId,
 Set<Long> actorIds,
 int fromIndex,
 int maxResults,
 String sortFieldName,
 OrderByType order)
                                         throws SActivityReadException

Description copied from interface: ActivityInstanceService

Get pending tasks for the user in specific actors. This is used for pagination

Specified by:

getPendingTasks in interface ActivityInstanceService

Parameters:

userId - identifier of user

actorIds - identifiers of actor

fromIndex - Index of the record to be retrieved from. First record has index 0

maxResults - Number of result we want to get. Maximum number of result returned

sortFieldName - the field used to do order

order - ASC or DESC

Returns:

a list of SActivityInstance objects

Throws:

SActivityReadException

getAssignedUserTasks

public List<SHumanTaskInstance> getAssignedUserTasks(long assigneeId,
 int fromIndex,
 int maxResults,
 String sortFieldName,
 OrderByType order)
                                              throws SActivityReadException

Description copied from interface: ActivityInstanceService

Get tasks assigned to the user. This is used for pagination

Specified by:

getAssignedUserTasks in interface ActivityInstanceService

Parameters:

assigneeId - identifier of user

fromIndex - Index of the record to be retrieved from. First record has index 0

maxResults - Number of result we want to get. Maximum number of result returned

sortFieldName - the field used to do order

order - ASC or DESC

Returns:

a list of SHumanTaskInstance objects

Throws:

SActivityReadException

getNumberOfOpenActivityInstances

public int getNumberOfOpenActivityInstances(long rootContainerId)
                                     throws SActivityReadException

Description copied from interface: ActivityInstanceService

Get total number of open activity instances for the specific process instance

Specified by:

getNumberOfOpenActivityInstances in interface ActivityInstanceService

Parameters:

rootContainerId - identifier of process instance

Returns:

the number of opened activity instances in the specific process instance

Throws:

SActivityReadException

getActivityInstances

public List<SActivityInstance> getActivityInstances(long rootContainerId,
 int fromIndex,
 int numberOfResults)
                                             throws SActivityReadException

Description copied from interface: ActivityInstanceService

Get all activity instances for the specific process instance

Specified by:

getActivityInstances in interface ActivityInstanceService

Parameters:

rootContainerId - identifier of root container, the root container can be process instance

Returns:

a list of SActivityInstance objects

Throws:

SActivityReadException

assignHumanTask

public void assignHumanTask(long userTaskId,
 long userId)
                     throws SFlowNodeNotFoundException,
SFlowNodeReadException,
SActivityModificationException

Description copied from interface: ActivityInstanceService

Assign the specific human task to the user

Specified by:

assignHumanTask in interface ActivityInstanceService

Parameters:

userTaskId - identifier of human task instance

userId - identifier of user

Throws:

SFlowNodeNotFoundException

SFlowNodeReadException

SActivityModificationException

assignHumanTaskIfNotAssigned

public void assignHumanTaskIfNotAssigned(long userTaskId,
 long userId)
                                  throws SFlowNodeNotFoundException,
SFlowNodeReadException,
SActivityModificationException,
SHumanTaskAlreadyAssignedException

Description copied from interface: ActivityInstanceService

Assign the specific human task to the user if it is not currently assigned

Use a more restrictive mechanism than assignHumanTask method to assign human task:

• exception when task is already assign to a different user
• only update claimed date when assign to same user
• remove claimed date when assign to user with id 0 (un-assign)

under high load, getting pending tasks could return tasks that are being assign in a previous transaction in a separate thread, and thus assignee is override

Specified by:

assignHumanTaskIfNotAssigned in interface ActivityInstanceService

Parameters:

userTaskId - identifier of human task instance

userId - identifier of user

Throws:

SFlowNodeNotFoundException

SFlowNodeReadException

SActivityModificationException

SHumanTaskAlreadyAssignedException

getNumberOfAssignedHumanTaskInstances

public long getNumberOfAssignedHumanTaskInstances(long userId)
                                           throws SActivityReadException

Description copied from interface: ActivityInstanceService

Get the number of UserTask instances assigned to a specific user

Specified by:

getNumberOfAssignedHumanTaskInstances in interface ActivityInstanceService

Parameters:

userId - the id of the user concerned

Returns:

the number of UserTask instances assigned to this specific user

Throws:

SActivityReadException - if a Read exception occurs

getArchivedActivityInstance

public SAActivityInstance getArchivedActivityInstance(long activityInstanceId,
 int stateId)
                                               throws SActivityReadException,
SActivityInstanceNotFoundException

Description copied from interface: ActivityInstanceService

Gets the archive instance of the activity according to its identifier at a given state.

Specified by:

getArchivedActivityInstance in interface ActivityInstanceService

stateId - the state identifier

Returns:

Throws:

SActivityReadException - if a Read exception occurs

SActivityInstanceNotFoundException

getNumberOfArchivedTasksManagedBy

public long getNumberOfArchivedTasksManagedBy(long managerUserId,
 QueryOptions searchOptions)
                                       throws SBonitaReadException

Description copied from interface: ActivityInstanceService

get the total number of archived tasks assigned to subordinates of specified manager.

Specified by:

getNumberOfArchivedTasksManagedBy in interface ActivityInstanceService

Parameters:

managerUserId - the userId of the manager

searchOptions - the search options to paginate, filter, ...

Returns:

the number of elements encountered

Throws:

SBonitaReadException - in case a search error occurs

searchArchivedTasksManagedBy

public List<SAHumanTaskInstance> searchArchivedTasksManagedBy(long managerUserId,
 QueryOptions searchOptions)
                                                       throws SBonitaReadException

Description copied from interface: ActivityInstanceService

get the archived tasks assigned to subordinates of specified manager, limited to, sorted, paginated with the specifies QueryOptions

Specified by:

searchArchivedTasksManagedBy in interface ActivityInstanceService

Parameters:

managerUserId - the userId of the manager

searchOptions - the search options to paginate, filter, sort ...

Returns:

the elements encountered matching the specified options

Throws:

SBonitaReadException - in case a search error occurs

getNumberOfArchivedHumanTasksSupervisedBy

public long getNumberOfArchivedHumanTasksSupervisedBy(long supervisorId,
 QueryOptions queryOptions)
                                               throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search AUserTask instances archived for a specific supervisor

Specified by:

getNumberOfArchivedHumanTasksSupervisedBy in interface ActivityInstanceService

queryOptions - the object used to manage all the search parameters of a query

Returns:

the number of UserTask archived to this specific supervisor

Throws:

SBonitaReadException

getNumberOfAssignedTasksSupervisedBy

public long getNumberOfAssignedTasksSupervisedBy(long supervisorId,
 QueryOptions queryOptions)
                                          throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search UserTask instances assigned for a specific supervisor

Specified by:

getNumberOfAssignedTasksSupervisedBy in interface ActivityInstanceService

Returns:

the number of UserTask assigned to this specific supervisor

Throws:

SBonitaReadException

searchAssignedTasksSupervisedBy

public List<SHumanTaskInstance> searchAssignedTasksSupervisedBy(long supervisorId,
 QueryOptions queryOptions)
                                                         throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search UserTask instances assigned for a specific supervisor

Specified by:

searchAssignedTasksSupervisedBy in interface ActivityInstanceService

queryOptions - the object used to manage all the search parameters of a query

Returns:

the UserTask instances list assigned to this specific supervisor

Throws:

SBonitaReadException

getNumberOfHumanTasks

public long getNumberOfHumanTasks(QueryOptions queryOptions)
                           throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Get number of human task instances according to the criteria

Specified by:

getNumberOfHumanTasks in interface ActivityInstanceService

Parameters:

queryOptions - the search options to paginate, filter, sort ...

Returns:

number of human task instances satisfied to the criteria

Throws:

SBonitaReadException

searchHumanTasks

public List<SHumanTaskInstance> searchHumanTasks(QueryOptions queryOptions)
                                          throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search all human task instances according to the criteria

Specified by:

searchHumanTasks in interface ActivityInstanceService

Parameters:

queryOptions - the search options to paginate, filter, sort ...

Returns:

a list of SHumanTaskInstance objects

Throws:

SBonitaReadException

searchArchivedHumanTasksSupervisedBy

public List<SAHumanTaskInstance> searchArchivedHumanTasksSupervisedBy(long supervisorId,
 QueryOptions queryOptions)
                                                               throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search AUserTask instances archived for a specific supervisor

Specified by:

searchArchivedHumanTasksSupervisedBy in interface ActivityInstanceService

queryOptions - the object used to manage all the search parameters of a query

Returns:

the UserTask instances list archived to this specific supervisor

Throws:

SBonitaReadException

searchArchivedTasks

public List<SAHumanTaskInstance> searchArchivedTasks(QueryOptions searchOptions)
                                              throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search archived human tasks according to specific search criteria

Specified by:

searchArchivedTasks in interface ActivityInstanceService

Parameters:

searchOptions - the object used to manage all the search parameters of a query

Returns:

a list of SAHumanTaskInstance objects

Throws:

SBonitaReadException

getNumberOfArchivedTasks

public long getNumberOfArchivedTasks(QueryOptions searchOptions)
                              throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Get total number of archived tasks according to specific search criteria

Specified by:

getNumberOfArchivedTasks in interface ActivityInstanceService

Parameters:

searchOptions - the object used to manage all the search parameters of a query

Returns:

Throws:

SBonitaReadException

getNumberOfAssignedTasksManagedBy

public long getNumberOfAssignedTasksManagedBy(long managerUserId,
 QueryOptions searchOptions)
                                       throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Get total number of assigned tasks managed by the specific manager

Specified by:

getNumberOfAssignedTasksManagedBy in interface ActivityInstanceService

Parameters:

managerUserId - identifier of manager user

searchOptions - the object used to manage all the search parameters of a query

Returns:

number of assigned tasks managed by the specific manager

Throws:

SBonitaReadException

searchAssignedTasksManagedBy

public List<SHumanTaskInstance> searchAssignedTasksManagedBy(long managerUserId,
 QueryOptions searchOptions)
                                                      throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Get all assigned tasks managed by the specific manager

Specified by:

searchAssignedTasksManagedBy in interface ActivityInstanceService

Parameters:

managerUserId - identifier of manager user

searchOptions - the object used to manage all the search parameters of a query

Returns:

a list of SHumanTaskInstance objects

Throws:

SBonitaReadException

searchPendingTasksSupervisedBy

public List<SHumanTaskInstance> searchPendingTasksSupervisedBy(long supervisorId,
 QueryOptions queryOptions)
                                                        throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search all pending human task instances for the specific supervisor

Specified by:

searchPendingTasksSupervisedBy in interface ActivityInstanceService

Parameters:

supervisorId - identifier of supervisor user

queryOptions - the search options to paginate, filter, sort ...

Returns:

a list of SHumanTaskInstance objects

Throws:

SBonitaReadException

getNumberOfPendingTasksSupervisedBy

public long getNumberOfPendingTasksSupervisedBy(long supervisorId,
 QueryOptions queryOptions)
                                         throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Get total number of pending human task instances for the specific supervisor

Specified by:

getNumberOfPendingTasksSupervisedBy in interface ActivityInstanceService

Parameters:

supervisorId - identifier of supervisor user

queryOptions - the search options to paginate, filter, sort ...

Returns:

number of pending human task instances for the specific supervisor

Throws:

SBonitaReadException

getNumberOfOpenTasksForUsers

public Map<Long,Long> getNumberOfOpenTasksForUsers(List<Long> userIds)
                                            throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Get number of open tasks for each user

Specified by:

getNumberOfOpenTasksForUsers in interface ActivityInstanceService

Parameters:

userIds - identifiers of users

Returns:

a map containing user id and corresponding task number

Throws:

SBonitaReadException

searchNumberOfPendingTasksManagedBy

public long searchNumberOfPendingTasksManagedBy(long managerUserId,
 QueryOptions searchOptions)
                                         throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search total number of pending tasks for the specific manager

Specified by:

searchNumberOfPendingTasksManagedBy in interface ActivityInstanceService

Parameters:

managerUserId - identifier of manager user

searchOptions - the search options to paginate, filter, sort ...

Returns:

number of pending tasks

Throws:

SBonitaReadException

searchPendingTasksManagedBy

public List<SHumanTaskInstance> searchPendingTasksManagedBy(long managerUserId,
 QueryOptions searchOptions)
                                                     throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search all pending tasks for the specific manager

Specified by:

searchPendingTasksManagedBy in interface ActivityInstanceService

Parameters:

managerUserId - identifier of manager user

searchOptions - the search options to paginate, filter, sort ...

Returns:

a list of SHumanTaskInstance objects

Throws:

SBonitaReadException

incrementLoopCounter

public void incrementLoopCounter(SLoopActivityInstance loopInstance)
                          throws SActivityModificationException

Description copied from interface: ActivityInstanceService

Increase loopCounter(loopCount+1) for the specific loop instance

Specified by:

incrementLoopCounter in interface ActivityInstanceService

Parameters:

loopInstance - the loopCounter in which will be increased

Throws:

SActivityModificationException

getNumberOfOverdueOpenTasksForUsers

public Map<Long,Long> getNumberOfOverdueOpenTasksForUsers(List<Long> userIds)
                                                   throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Get number of overdue open tasks for each user

Specified by:

getNumberOfOverdueOpenTasksForUsers in interface ActivityInstanceService

Parameters:

userIds - identifiers of users

Returns:

a map containing userId and corresponding number of tasks

Throws:

SBonitaReadException

getChildrenOfAnActivity

public List<SActivityInstance> getChildrenOfAnActivity(long parentActivityInstanceId,
 int fromIndex,
 int numberOfResults)
                                                throws SActivityReadException

Description copied from interface: ActivityInstanceService

Get all child instances for the specific parent activity instance, order by id ascending.

Specified by:

getChildrenOfAnActivity in interface ActivityInstanceService

Parameters:

parentActivityInstanceId - identifier of parent activity instance

fromIndex - Index of the record to be retrieved from. First record has index 0

numberOfResults - TODO

Returns:

a list of SActivityInstance objects

Throws:

SActivityReadException

setLoopMax

public void setLoopMax(SLoopActivityInstance loopActivity,
 Integer loopMap)
                throws SActivityModificationException

Description copied from interface: ActivityInstanceService

Set max loop for the specific loopActvity

Specified by:

setLoopMax in interface ActivityInstanceService

Parameters:

loopActivity - the loopActivity

loopMap - value for max loop

Throws:

SActivityModificationException

setLoopCardinality

public void setLoopCardinality(SFlowNodeInstance flowNodeInstance,
 int intLoopCardinality)
                        throws SActivityModificationException

Description copied from interface: ActivityInstanceService

Set LoopCardinality for the specific loopActvity

Specified by:

setLoopCardinality in interface ActivityInstanceService

Parameters:

flowNodeInstance - the loopActvity

intLoopCardinality - value of loop cardinality

Throws:

SActivityModificationException

addMultiInstanceNumberOfActiveActivities

public void addMultiInstanceNumberOfActiveActivities(SMultiInstanceActivityInstance flowNodeInstance,
 int number)
                                              throws SActivityModificationException

Description copied from interface: ActivityInstanceService

Add number of activeInstances for the specific SMultiInstanceActivityInstance object

Specified by:

addMultiInstanceNumberOfActiveActivities in interface ActivityInstanceService

Parameters:

flowNodeInstance - an SMultiInstanceActivityInstance object

number - the number will be added

Throws:

SActivityModificationException

addMultiInstanceNumberOfTerminatedActivities

public void addMultiInstanceNumberOfTerminatedActivities(SMultiInstanceActivityInstance flowNodeInstance,
 int number)
                                                  throws SActivityModificationException

Description copied from interface: ActivityInstanceService

Add number of terminated activeInstances for the specific SMultiInstanceActivityInstance object

Specified by:

addMultiInstanceNumberOfTerminatedActivities in interface ActivityInstanceService

Parameters:

flowNodeInstance - an SMultiInstanceActivityInstance object

number - will be added to terminated instances of flowNodeInstance the number will be added

Throws:

SActivityModificationException

addMultiInstanceNumberOfCompletedActivities

public void addMultiInstanceNumberOfCompletedActivities(SMultiInstanceActivityInstance flowNodeInstance,
 int number)
                                                 throws SActivityModificationException

Description copied from interface: ActivityInstanceService

Add number of completed activeInstances for the specific SMultiInstanceActivityInstance object

Specified by:

addMultiInstanceNumberOfCompletedActivities in interface ActivityInstanceService

Parameters:

flowNodeInstance - an SMultiInstanceActivityInstance object whose completed activity number will be updated

number - the number will be added

Throws:

SActivityModificationException

getNumberOfActivityInstances

public long getNumberOfActivityInstances(Class<? extends PersistentObject> entityClass,
 QueryOptions searchOptions)
                                  throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Get total number of activity instances for the specific entity class

Specified by:

getNumberOfActivityInstances in interface ActivityInstanceService

Parameters:

entityClass - to indicate which type of class will be retrieved

searchOptions - the search options to paginate, filter, sort ...

Returns:

number of activity instances for the specific entity class

Throws:

SBonitaReadException

searchActivityInstances

public List<SActivityInstance> searchActivityInstances(Class<? extends PersistentObject> entityClass,
 QueryOptions searchOptions)
                                                throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search all activity instances for the specific entity class

Specified by:

searchActivityInstances in interface ActivityInstanceService

Parameters:

entityClass - to indicate which type of class will be retrieved

searchOptions - the search options to paginate, filter, sort ...

Returns:

a list of SActivityInstance objects

Throws:

SBonitaReadException

getNumberOfArchivedActivityInstances

public long getNumberOfArchivedActivityInstances(Class<? extends PersistentObject> entityClass,
 QueryOptions searchOptions)
                                          throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Get total number of archived activity instances for the specific entity class

Specified by:

getNumberOfArchivedActivityInstances in interface ActivityInstanceService

Parameters:

entityClass - to indicate which type of class will be retrieved

searchOptions - the search options to paginate, filter, sort ...

Returns:

number of archived activity instances for the specific entity class

Throws:

SBonitaReadException

searchArchivedActivityInstances

public List<SAActivityInstance> searchArchivedActivityInstances(Class<? extends PersistentObject> entityClass,
 QueryOptions searchOptions)
                                                         throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search all archived activity instances for the specific entity class

Specified by:

searchArchivedActivityInstances in interface ActivityInstanceService

Parameters:

entityClass - to indicate which type of class will be retrieved

searchOptions - the search options to paginate, filter, sort ...

Returns:

a list of SAActivityInstance objects

Throws:

SBonitaReadException

setTokenCount

public void setTokenCount(SActivityInstance activityInstance,
 int tokenCount)
                   throws SFlowNodeModificationException

Description copied from interface: ActivityInstanceService

Set tokenCount for the specific activity instance

Specified by:

setTokenCount in interface ActivityInstanceService

Parameters:

activityInstance - the activityInstance will be updated

tokenCount - value of tokenCount will be set to the activity

Throws:

SFlowNodeModificationException

getNumberOfPendingTasksForUser

public long getNumberOfPendingTasksForUser(long userId,
 QueryOptions searchOptions)
                                    throws SBonitaReadException

Specified by:

getNumberOfPendingTasksForUser in interface ActivityInstanceService

Returns:

Throws:

SBonitaReadException

searchPendingTasksForUser

public List<SHumanTaskInstance> searchPendingTasksForUser(long userId,
 QueryOptions searchOptions)
                                                   throws SBonitaReadException

Specified by:

searchPendingTasksForUser in interface ActivityInstanceService

Returns:

Throws:

SBonitaReadException

searchPendingTasksAssignedTo

public List<SHumanTaskInstance> searchPendingTasksAssignedTo(long userId,
 QueryOptions searchOptions)
                                                      throws SBonitaReadException

Specified by:

searchPendingTasksAssignedTo in interface ActivityInstanceService

Throws:

SBonitaReadException

getNumberOfPendingOrAssignedTasks

public long getNumberOfPendingOrAssignedTasks(long userId,
 QueryOptions searchOptions)
                                       throws SBonitaReadException

Specified by:

getNumberOfPendingOrAssignedTasks in interface ActivityInstanceService

Returns:

Throws:

SBonitaReadException

getNumberOfPendingOrAssignedOrAssignedToOthersTasks

public long getNumberOfPendingOrAssignedOrAssignedToOthersTasks(long userId,
 QueryOptions searchOptions)
                                                         throws SBonitaReadException

Specified by:

getNumberOfPendingOrAssignedOrAssignedToOthersTasks in interface ActivityInstanceService

Returns:

Throws:

SBonitaReadException

getNumberOfPendingTasksAssignedTo

public long getNumberOfPendingTasksAssignedTo(long userId,
 QueryOptions searchOptions)
                                       throws SBonitaReadException

Specified by:

getNumberOfPendingTasksAssignedTo in interface ActivityInstanceService

Throws:

SBonitaReadException

searchPendingOrAssignedTasks

public List<SHumanTaskInstance> searchPendingOrAssignedTasks(long userId,
 QueryOptions searchOptions)
                                                      throws SBonitaReadException

Specified by:

searchPendingOrAssignedTasks in interface ActivityInstanceService

Returns:

Throws:

SBonitaReadException

searchPendingOrAssignedOrAssignedToOthersTasks

public List<SHumanTaskInstance> searchPendingOrAssignedOrAssignedToOthersTasks(long userId,
 QueryOptions searchOptions)
                                                                        throws SBonitaReadException

Specified by:

searchPendingOrAssignedOrAssignedToOthersTasks in interface ActivityInstanceService

Returns:

Throws:

SBonitaReadException

setAbortedByBoundaryEvent

public void setAbortedByBoundaryEvent(SActivityInstance activityInstance,
 long boundaryEventId)
                               throws SActivityModificationException

Specified by:

setAbortedByBoundaryEvent in interface ActivityInstanceService

Throws:

SActivityModificationException

getPossibleUserIdsOfPendingTasks

public List<Long> getPossibleUserIdsOfPendingTasks(long humanTaskInstanceId,
 int startIndex,
 int maxResults)
                                            throws SActivityReadException

Specified by:

getPossibleUserIdsOfPendingTasks in interface ActivityInstanceService

Throws:

SActivityReadException

isTaskPendingForUser

public boolean isTaskPendingForUser(long humanTaskInstanceId,
 long userId)
                             throws SBonitaReadException

Specified by:

isTaskPendingForUser in interface ActivityInstanceService

Throws:

SBonitaReadException

getNumberOfUsersWhoCanExecutePendingHumanTaskDeploymentInfo

public long getNumberOfUsersWhoCanExecutePendingHumanTaskDeploymentInfo(long humanTaskInstanceId,
 QueryOptions searchOptions)
                                                                 throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Get total number of users according to specific query options, and who can start the task filtered with the search option of the given process definition

Specified by:

getNumberOfUsersWhoCanExecutePendingHumanTaskDeploymentInfo in interface ActivityInstanceService

searchOptions - The QueryOptions object containing some query conditions

Returns:

Throws:

SBonitaReadException

searchUsersWhoCanExecutePendingHumanTaskDeploymentInfo

public List<SUser> searchUsersWhoCanExecutePendingHumanTaskDeploymentInfo(long humanTaskInstanceId,
 QueryOptions searchOptions)
                                                                   throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search the users according to specific query options, and who can start the task filtered with the search option of the given process definition

Specified by:

searchUsersWhoCanExecutePendingHumanTaskDeploymentInfo in interface ActivityInstanceService

searchOptions - The QueryOptions object containing some query conditions

Returns:

Throws:

SBonitaReadException

getNumberOfAssignedAndPendingHumanTasksFor

public long getNumberOfAssignedAndPendingHumanTasksFor(long rootProcessDefinitionId,
 long userId,
 QueryOptions queryOptions)
                                                throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Get the total number of the assigned and pending human tasks for the specified user, on the specified root process definition, corresponding to the options.

Specified by:

getNumberOfAssignedAndPendingHumanTasksFor in interface ActivityInstanceService

Parameters:

rootProcessDefinitionId - The identifier of the root process definition

userId - The identifier of the user

queryOptions - The search conditions and the options for sorting and paging the results.

Returns:

The assigned and pending human tasks

Throws:

SBonitaReadException

searchAssignedAndPendingHumanTasksFor

public List<SHumanTaskInstance> searchAssignedAndPendingHumanTasksFor(long rootProcessDefinitionId,
 long userId,
 QueryOptions queryOptions)
                                                               throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search the assigned and pending human tasks for the specified user, on the specified root process definition, corresponding to the options.

Specified by:

searchAssignedAndPendingHumanTasksFor in interface ActivityInstanceService

Parameters:

rootProcessDefinitionId - The identifier of the root process definition

userId - The identifier of the user

queryOptions - The search conditions and the options for sorting and paging the results.

Returns:

The assigned and pending human tasks

Throws:

SBonitaReadException

getNumberOfAssignedAndPendingHumanTasks

public long getNumberOfAssignedAndPendingHumanTasks(long rootProcessDefinitionId,
 QueryOptions queryOptions)
                                             throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Get the total number of the assigned and pending human tasks for any user, on the specified root process definition, corresponding to the options.

Specified by:

getNumberOfAssignedAndPendingHumanTasks in interface ActivityInstanceService

Parameters:

rootProcessDefinitionId - The identifier of the root process definition

queryOptions - The search conditions and the options for sorting and paging the results.

Returns:

The assigned and pending human tasks

Throws:

SBonitaReadException

searchAssignedAndPendingHumanTasks

public List<SHumanTaskInstance> searchAssignedAndPendingHumanTasks(long rootProcessDefinitionId,
 QueryOptions queryOptions)
                                                            throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search the assigned and pending human tasks for any user, on the specified root process definition, corresponding to the options.

Specified by:

searchAssignedAndPendingHumanTasks in interface ActivityInstanceService

Parameters:

rootProcessDefinitionId - The identifier of the root process definition

queryOptions - The search conditions and the options for sorting and paging the results.

Returns:

The assigned and pending human tasks

Throws:

SBonitaReadException

getNumberOfAssignedAndPendingHumanTasks

public long getNumberOfAssignedAndPendingHumanTasks(QueryOptions queryOptions)
                                             throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Get the total number of the assigned and pending human tasks for any user corresponding to the options.

Specified by:

getNumberOfAssignedAndPendingHumanTasks in interface ActivityInstanceService

Parameters:

queryOptions - The search conditions and the options for sorting and paging the results.

Returns:

The assigned and pending human tasks

Throws:

SBonitaReadException

searchAssignedAndPendingHumanTasks

public List<SHumanTaskInstance> searchAssignedAndPendingHumanTasks(QueryOptions queryOptions)
                                                            throws SBonitaReadException

Description copied from interface: ActivityInstanceService

Search the assigned and pending human tasks for any user corresponding to the options.

Specified by:

searchAssignedAndPendingHumanTasks in interface ActivityInstanceService

Parameters:

queryOptions - The search conditions and the options for sorting and paging the results.

Returns:

The assigned and pending human tasks

Throws:

SBonitaReadException