com.canto.cumulus.utils

Class WorkflowManager

java.lang.Object

com.canto.cumulus.utils.WorkflowManager

public final class WorkflowManager
extends java.lang.Object

Helper class to work with workflows.

Since:

9.2

Method Summary

Methods

Modifier and Type	Method and Description
void	applyActivity(RecordItem recordItem, GUID workflowID, int activityID, int destinationStateID, java.util.Set<java.lang.String> dynamicAssignments, int languageID) Applies the given activity on the given record.
void	applyActivity(RecordItem recordItem, GUID workflowID, int activityID, int destinationStateID, java.util.Set<java.lang.String> dynamicAssignments, java.lang.String initiatingUserUID, int languageID) Applies the given activity on the given record.
java.util.Map<Workflow,java.util.List<WorkflowActivity>>	getAvailableActivities(MultiRecordItemCollection multiRecordItemCollection, java.util.List<ItemIdentifier> itemIDs, GUID workflowID, boolean onlyInitialActivities) Return a list of workflow activities that can be applied to the given records.
static WorkflowManager	getInstance() Returns the WorkflowManager to work with.
java.lang.String	getMatchingRecordsQuery(CumulusSession cumulusSession, Workflow workflow, int activityID) Returns a query string which finds all records where the given activity can be applied on.
java.util.Map<GUID,java.lang.String>	getUserTODOQuery(MultiRecordItemCollection multiRecordItemCollection) Returns queries which finds the records in a workflow the current user is assigned to.
java.lang.String	getUserTODOQuery(MultiRecordItemCollection multiRecordItemCollection, GUID workflowID) Returns a query which finds the records in the given workflow the current user is assigned to.
java.util.Map<GUID,java.lang.String>	getUserTODOQuery(RecordItemCollection recordItemCollection) Returns queries which finds the records in a workflow the current user is assigned to.
java.lang.String	getUserTODOQuery(RecordItemCollection recordItemCollection, GUID workflowID) Returns a query which finds the records in the given workflow the current user is assigned to.
boolean	isCompliantWithActivityRestrictions(RecordItem recordItem, WorkflowActivity workflowActivity) Returns whether the user and record restrictions of the given activity are matched by the given record.
boolean	isCompliantWithRecordRestrictions(RecordItem recordItem, WorkflowActivity workflowActivity) Returns whether the record restrictions of the given activity are matched by the given record.
boolean	isCompliantWithUserRestrictions(RecordItem recordItem, WorkflowActivity workflowActivity) Returns whether the user restrictions of the given activity are matched by the given record.
boolean	isCompliantWithUserRestrictions(UserContext userContext, WorkflowActivity workflowActivity) Returns whether the user restrictions of the given activity are matched by the given record.
boolean	isWorkflowStarted(RecordItem recordItem, GUID workflowID) Returns whether the workflow has been started on the given record.
java.lang.String	mergeQueries(java.util.Map<GUID,java.lang.String> queries) Merges the given queries per workflow into a single query to find all records the current user is assigned to with a single search.
void	resetWorkflow(RecordItem recordItem, GUID workflowID, int languageID) Resets a workflow on the given record.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static WorkflowManager getInstance()

Returns the WorkflowManager to work with.

Returns:

WorkflowManager instance

getAvailableActivities

public java.util.Map<Workflow,java.util.List<WorkflowActivity>> getAvailableActivities(MultiRecordItemCollection multiRecordItemCollection,
                                                                              java.util.List<ItemIdentifier> itemIDs,
                                                                              GUID workflowID,
                                                                              boolean onlyInitialActivities)

Return a list of workflow activities that can be applied to the given records.

Parameters:

multiRecordItemCollection - The collection containing all catalogs to work with. If the itemIDs is null then it checks all records of the collection.

itemIDs - The ids of the records to check. If this is null then the above collection contents is checked.

workflowID - The ID of the workflow to check. If this is null then all workflows defined for the catalogs are processed.

Returns:

The list of workflow activities that the current user can apply to all of the given records.

getMatchingRecordsQuery

public java.lang.String getMatchingRecordsQuery(CumulusSession cumulusSession,
                                       Workflow workflow,
                                       int activityID)

Returns a query string which finds all records where the given activity can be applied on. The query checks the current state and the record restriction specified for the given activity. It does not check the user restriction as this should be checked only once when initializing the workflow support of an application.

Parameters:

cumulusSession - session to work with

workflow - workflow instance to work with

activityID - ID of activity you are interested in

Returns:

query string which finds all records the given activity can be applied on

getUserTODOQuery

public java.util.Map<GUID,java.lang.String> getUserTODOQuery(MultiRecordItemCollection multiRecordItemCollection)

Returns queries which finds the records in a workflow the current user is assigned to. The returned map maps the workflow ID to the query string. All workflows available in any of the catalogs of the given collection are processed.

Parameters:

multiRecordItemCollection - collection to work with

Returns:

map with workflow ID pointing to workflow specific query string

See Also:

mergeQueries(java.util.Map)

getUserTODOQuery

public java.util.Map<GUID,java.lang.String> getUserTODOQuery(RecordItemCollection recordItemCollection)

Returns queries which finds the records in a workflow the current user is assigned to. The returned map maps the workflow ID to the query string. All workflows available in the catalog of the given collection are processed.

Parameters:

recordItemCollection - collection to work with

Returns:

map with workflow ID pointing to workflow specific query string

See Also:

mergeQueries(java.util.Map)

getUserTODOQuery

public java.lang.String getUserTODOQuery(RecordItemCollection recordItemCollection,
                                GUID workflowID)

Returns a query which finds the records in the given workflow the current user is assigned to.

Parameters:

recordItemCollection - collection to work with

workflowID - the workflow to return the query for

Returns:

generated query string or null if the given workflow cannot be found

getUserTODOQuery

public java.lang.String getUserTODOQuery(MultiRecordItemCollection multiRecordItemCollection,
                                GUID workflowID)

Returns a query which finds the records in the given workflow the current user is assigned to.

Parameters:

multiRecordItemCollection - collection to work with

workflowID - the workflow to return the query for

Returns:

generated query string or null if the given workflow cannot be found

mergeQueries

public java.lang.String mergeQueries(java.util.Map<GUID,java.lang.String> queries)

Merges the given queries per workflow into a single query to find all records the current user is assigned to with a single search.

Parameters:

queries - workflow queries to merge

Returns:

merged query

See Also:

getUserTODOQuery(com.canto.cumulus.RecordItemCollection), getUserTODOQuery(com.canto.cumulus.MultiRecordItemCollection)

isCompliantWithActivityRestrictions

public boolean isCompliantWithActivityRestrictions(RecordItem recordItem,
                                          WorkflowActivity workflowActivity)

Returns whether the user and record restrictions of the given activity are matched by the given record. The result is the combination of isCompliantWithUserRestrictions(com.canto.cumulus.UserContext, com.canto.cumulus.prefs.WorkflowActivity) and isCompliantWithRecordRestrictions(com.canto.cumulus.RecordItem, com.canto.cumulus.prefs.WorkflowActivity).

Parameters:

recordItem - item to check

workflowActivity - activity to check

Returns:

true if the given activity can be applied on the given record, false otherwise

isCompliantWithUserRestrictions

public boolean isCompliantWithUserRestrictions(UserContext userContext,
                                      WorkflowActivity workflowActivity)

Returns whether the user restrictions of the given activity are matched by the given record.

Parameters:

userContext - user to check

workflowActivity - activity to check

Returns:

true if the user restrictions of the given activity are matched by the given record, false otherwise

See Also:

isCompliantWithActivityRestrictions(com.canto.cumulus.RecordItem, com.canto.cumulus.prefs.WorkflowActivity)

isCompliantWithUserRestrictions

public boolean isCompliantWithUserRestrictions(RecordItem recordItem,
                                      WorkflowActivity workflowActivity)

Returns whether the user restrictions of the given activity are matched by the given record.

Parameters:

recordItem - item to check

workflowActivity - activity to check

Returns:

true if the user restrictions of the given activity are matched by the given record, false otherwise

See Also:

isCompliantWithActivityRestrictions(com.canto.cumulus.RecordItem, com.canto.cumulus.prefs.WorkflowActivity)

isCompliantWithRecordRestrictions

public boolean isCompliantWithRecordRestrictions(RecordItem recordItem,
                                        WorkflowActivity workflowActivity)

Returns whether the record restrictions of the given activity are matched by the given record.

Parameters:

recordItem - item to check

workflowActivity - activity to check

Returns:

true if the record restrictions of the given activity are matched by the given record, false otherwise

See Also:

isCompliantWithActivityRestrictions(com.canto.cumulus.RecordItem, com.canto.cumulus.prefs.WorkflowActivity)

applyActivity

public void applyActivity(RecordItem recordItem,
                 GUID workflowID,
                 int activityID,
                 int destinationStateID,
                 java.util.Set<java.lang.String> dynamicAssignments,
                 int languageID)

Applies the given activity on the given record. The given destination state is ignored if the activity has only one destination state. The list of resulting dynamic assignments is ignored if the activity is not configured for dynamic assignment. The given language specifies the language to use when creating the log entry in the workflow activity history table.

Parameters:

recordItem - item to process

workflowID - workflow to use

activityID - activity to apply on the given record

destinationStateID - destination state to use if the given activity supports multiple destination states, otherwise the value is ignored

dynamicAssignments - list of resulting assignments if the given activity uses dynamic assignments, can be null otherwise

languageID - specifies the language to use when creating the log entry in the workflow activity history table

applyActivity

public void applyActivity(RecordItem recordItem,
                 GUID workflowID,
                 int activityID,
                 int destinationStateID,
                 java.util.Set<java.lang.String> dynamicAssignments,
                 java.lang.String initiatingUserUID,
                 int languageID)

Applies the given activity on the given record. The given destination state is ignored if the activity has only one destination state. The list of resulting dynamic assignments is ignored if the activity is not configured for dynamic assignment. The given language specifies the language to use when creating the log entry in the workflow activity history table.

Parameters:

recordItem - item to process

workflowID - workflow to use

activityID - activity to apply on the given record

destinationStateID - destination state to use if the given activity supports multiple destination states, otherwise the value is ignored

dynamicAssignments - list of resulting assignments if the given activity uses dynamic assignments, can be null otherwise

initiatingUserUID - Optional: the user UID of the initiating user to be assigned in case the workflow activity is configured to assign it to the initiating user. If the is null then the user context of the recordItem parameter is used.

languageID - specifies the language to use when creating the log entry in the workflow activity history table

Since:

11.1

resetWorkflow

public void resetWorkflow(RecordItem recordItem,
                 GUID workflowID,
                 int languageID)

Resets a workflow on the given record. The function clears the workflows state string list field value and removes all assignments. The given language specifies the language to use when creating the log entry in the workflow activity history table. This operation requires the PredefinedPermissions.SERVER_PERMISSION_WORKFLOW_ADMIN permission.

Parameters:

recordItem - item to process

workflowID - workflow to use

languageID - specifies the language to use when creating the log entry in the workflow activity history table

Since:

10.0

isWorkflowStarted

public boolean isWorkflowStarted(RecordItem recordItem,
                        GUID workflowID)

Returns whether the workflow has been started on the given record.

Parameters:

recordItem - item to process

workflowID - workflow to use

Since:

10.0.1