Package com.emc.d2fs.interfaces
Interface IWorkflowService
- All Superinterfaces:
ID2fsService
Workflow management services.
-
Method Summary
Modifier and TypeMethodDescriptionabortWorkflow
(Context context, String id) Abort workflow for specified taskboolean
acquireTask
(Context context, String id, boolean forceAcquire, boolean forceRead) Manage task acquisition and read stateacquireTaskAndGetState
(Context context, String id, boolean forceAcquire, boolean forceRead) Manage task acquisition and read stateboolean
addNoteToTask
(Context context, String id, String comment) Add note to taskboolean
canAbortWorkflow
(Context context, String id) Check if user can abort the workflowboolean
canAddTaskNote
(Context context, String id) Check if user can add a note to the taskboolean
canDelegateTask
(Context context, String id) Check if user can delegate the taskboolean
canForwardTask
(Context context, String id) Check if user can forward the taskboolean
canRejectTask
(Context context, String id) Check if user can reject the taskboolean
checkAttachmentLockState
(Context context, String id, List<Attribute> parameters) Check lifecycleboolean
checkLifeCycle
(Context context, String id, List<Attribute> parameters) Check lifecyclecheckPropertyPage
(Context context, String id, String operation) Deprecated.Move to method with NextTaskId argument.checkPropertyPage
(Context context, String id, String operation, String nextTaskId) Check if property page is linked to task operationboolean
checkWorkflowAliases
(Context context, String id, List<Attribute> parameters) boolean
delegateTask
(Context context, String id, String user) Delegate task to another userboolean
delegateTaskOnError
(Context context, String id) Delegate task to workflow administratordefault void
forwardTask
(Context context, String id) getConfigurationsNames
(Context context, String id) Get workflow configurations list for documentgetTaskFolderLabel
(Context context, String id) Get task folder label with unread countgetTaskMode
(Context context, String id, List<Attribute> parameters) Get process task mode (direct, need dialog, need sign off)getTaskPermissions
(Context context, String taskId) Populate all the Task permissions for the given task idgetWorkflowDisplayName
(Context context, String configName) Get the workflow display name for this usergetWorkflowStatusSummary
(Context context, String widgetName) boolean
isManualAcquisitionTask
(Context context, String id) Check if task acquisition is manual or automaticboolean
isTaskAcquired
(Context context, String id) Check if task is acquiredboolean
launchScheduledWorkflow
(Context context, String id) Launch a scheduled workflow.launchWorkflow
(Context context, List<Attribute> parameters) Launch document into workflowvoid
pauseWorkflow
(Context context, String id) boolean
processTask
(Context context, String id, List<Attribute> parameters) Process task by forwarding or rejecting it through workflowvoid
resumeWorkflow
(Context context, String id) boolean
setTaskPriority
(Context context, String id, int priority) Change task priorityboolean
setTaskReadState
(Context context, String id, boolean read) Change task read state (read/unread)default String
updatePerformer
(Context context, String id, List<Attribute> parameters) Update Performer will update the performer list of an alias.boolean
verifyEntryCriteria
(Context context, String id, String config) Check if document respond to workflow entry criteriaverifyEntryCriterias
(Context context, List<String> ids, String config) Check if documents respond to workflow entry criteriaMethods inherited from interface com.emc.d2fs.interfaces.ID2fsService
isRemote, setRemote
-
Method Details
-
isTaskAcquired
Check if task is acquired -
isManualAcquisitionTask
Check if task acquisition is manual or automatic -
canForwardTask
Check if user can forward the task -
forwardTask
- Throws:
Exception
-
canRejectTask
Check if user can reject the task -
canDelegateTask
Check if user can delegate the task -
canAddTaskNote
Check if user can add a note to the task -
canAbortWorkflow
Check if user can abort the workflow -
acquireTaskAndGetState
AcquireWorkflowTaskResponse acquireTaskAndGetState(Context context, String id, boolean forceAcquire, boolean forceRead) throws Exception Manage task acquisition and read state- Parameters:
context
-Context
object containing informations about client/sessionid
- String value of task idforceAcquire
- Boolean value to force ensure task acquisition (in manual acquisition mode)forceRead
- Boolean value to force read state (read or unread)- Returns:
TaskResponse
if process performs without error- Throws:
Exception
- Since:
- 4.0.1
-
acquireTask
boolean acquireTask(Context context, String id, boolean forceAcquire, boolean forceRead) throws Exception Manage task acquisition and read state- Parameters:
context
-Context
object containing informations about client/sessionid
- String value of task idforceAcquire
- Boolean value to force ensure task acquisition (in manual acquisition mode)forceRead
- Boolean value to force read state (read or unread)- Returns:
- true if process performs without error
- Throws:
Exception
- Since:
- 4.0.1
-
checkLifeCycle
Check lifecycle -
checkPropertyPage
Deprecated.Move to method with NextTaskId argument.Check if property page is linked to task operation -
checkPropertyPage
String checkPropertyPage(Context context, String id, String operation, String nextTaskId) throws Exception Check if property page is linked to task operation -
checkWorkflowAliases
-
processTask
Process task by forwarding or rejecting it through workflow -
addNoteToTask
Add note to task -
delegateTask
Delegate task to another user -
checkAttachmentLockState
boolean checkAttachmentLockState(Context context, String id, List<Attribute> parameters) throws Exception Check lifecycle -
delegateTaskOnError
Delegate task to workflow administrator -
setTaskReadState
Change task read state (read/unread) -
setTaskPriority
Change task priority -
getTaskFolderLabel
Get task folder label with unread count -
verifyEntryCriteria
Check if document respond to workflow entry criteria -
verifyEntryCriterias
List<Attribute> verifyEntryCriterias(Context context, List<String> ids, String config) throws Exception Check if documents respond to workflow entry criteria -
launchWorkflow
Launch document into workflow- Parameters:
context
-Context
object containing informations about client/sessionparameters
-Attribute
list of workflow parametersParameters:
- config: DF_STRING - Workflow config (ie. "WF HR Read and Understood")
- name: DF_STRING - Workflow tracker name (ie. "WF HR Read and Understood" + new Date())
- id: DF_STRING - Id or list of ids of documents in the workflow. (separated by AttributeUtils.SEPARATOR_VALUE)
(optional) - add_document_id: DF_STRING - Id or list of ids of workflow attachments.
- end_of_workflow: DF_STRING - Date of scheduled end. Notification will be sent before end.
- launch_date: DF_STRING - Date of scheduled start. Launch now if empty.
- launch_notification: DF_BOOLEAN - True to send notification on start.
- notification: DF_STRING - Note to accompany the workflow instance.
(workflow specific) - {Performer Alias Name}: DF_STRING -- Attribute named for the workflow configuration's performer alias. Values are workflow performers (separated by AttributeUtils.SEPARATOR_VALUE)
For Example 'WF HR Read and Understood' config: - Recipients: DF_STRING - List of workflow performer values, one attribute for each of WF alias. In this case, it is a simple WF with only one manual task where the performer alias is named "Recipients". (separated by AttributeUtils.SEPARATOR_VALUE)
- Returns:
- String value of launch message
- Throws:
Exception
- Since:
- 4.0.1
-
abortWorkflow
Abort workflow for specified task -
pauseWorkflow
- Throws:
Exception
-
resumeWorkflow
- Throws:
Exception
-
getTaskMode
Get process task mode (direct, need dialog, need sign off) -
launchScheduledWorkflow
Launch a scheduled workflow. -
getConfigurationsNames
Get workflow configurations list for document -
getWorkflowDisplayName
Get the workflow display name for this user- Parameters:
context
-configName
-- Returns:
- Throws:
Exception
-
getTaskPermissions
Populate all the Task permissions for the given task id -
updatePerformer
default String updatePerformer(Context context, String id, List<Attribute> parameters) throws Exception Update Performer will update the performer list of an alias. -
getWorkflowStatusSummary
default Map<Integer,Long> getWorkflowStatusSummary(Context context, String widgetName) throws Exception - Throws:
Exception
-