This section describes the WorkflowService interface.
The Workflow service manages workflow processes and tasks inside a SkyVault repository. There are various methods relating to the WorkflowService, including the ability to:
- Start new workflow process
- List and filter workflow processes and tasks
- Complete tasks
- Assign/reassign/claim workflow task
- Delete workflow process
Each type of workflow is defined by a workflow process definition, which can be thought of as a template for a workflow. A new workflow can be created from a process definition. You can think of the process definition as the "class" and the process as the "object". Each workflow instance, of a particular type, can consist of multiple tasks.
In SkyVault 4.2 the default workflow engine is Activiti.
Class declaration
public interface WorkflowService extends Service
Inherits from | Implements |
---|---|
Service | None |
Workflow service filter constants
Constant | Type | Description |
---|---|---|
FILTER_KEY_STATUS | String | Filter based on status of the task. Value can be FILTER_STATUS_ANY, FILTER_STATUS_ACTIVE, FILTER_STATUS_COMPLETE. See getTasks. |
FILTER_STATUS_ANY | int | All tasks are returned. |
FILTER_STATUS_ACTIVE | int | Only active (not completed) tasks are returned. |
FILTER_STATUS_COMPLETE | int | Only completed tasks are returned. |
FILTER_KEY_DUE | String | Filter based on due date of the task. Value can be FILTER_DUE_TODAY, FILTER_DUE_TOMORROW, FILTER_DUE_7DAYS, FILTER_DUE_OVERDUE, FILTER_DUE_NODATE. See getTasks. |
FILTER_DUE_TODAY | int | Only tasks which are due today. |
FILTER_DUE_TOMORROW | int | Only tasks which are due tomorrow. |
FILTER_DUE_7DAYS | int | Only tasks which are due in the next 7 days. |
FILTER_DUE_OVERDUE | int | Only tasks which are overdue. |
FILTER_DUE_NODATE | int | Only tasks with no due date. |
FILTER_KEY_PRIORITY | String | Filter based on priority of the task. Value can be FILTER_PRIORITY_HIGH, FILTER_PRIORITY_MEDIUM, FILTER_PRIORITY_LOW. See getTasks. |
FILTER_PRIORITY_LOW | int | Only tasks with a low priority. |
FILTER_PRIORITY_MEDIUM | int | Only tasks with a medium priority. |
FILTER_PRIORITY_HIGH | int | Only tasks with a high priority. |
FILTER_KEY_ASSIGNEE | String | Filter based on the assignee of the task. Value can be FILTER_ASSIGNEE_ME, FILTER_ASSIGNEE_UNASSIGNED, or the string value representing the unique identifier of a person. See getTasks. |
FILTER_ASSIGNEE_ME | int | Only tasks explicitly assigned to the current user. |
FILTER_ASSIGNEE_UNASSIGNED | int | Only unassigned tasks current user can claim (member of the group). |
FILTER_ASSIGNEE_ALL | int | Tasks assigned to the current user and unassigned task current user can claim (member of the group). |
FILTER_NO_ASSIGNEE | int | Tasks not assigned to the current user. |
FILTER_KEY_INITIATOR | String | TBD |
FILTER_INITIATOR_ME | int | Only tasks explicitly assigned to the current user. |
FILTER_INITIATOR_ANY | int | Tasks assigned to anybody. |