WorkflowService (Alfresco 5.0.3 Public API)

org.alfresco.service.cmr.workflow

Interface WorkflowService

public interface WorkflowService

Workflow Service. Client facing API for interacting with Alfresco Workflows and Tasks.

Method Summary
WorkflowInstance	cancelWorkflow(String workflowId) Cancel an "in-flight" Workflow instance
List<WorkflowInstance>	cancelWorkflows(List<String> workflowIds) Cancel a batch of "in-flight" Workflow instances
long	countTasks(WorkflowTaskQuery workflowTaskQuery) Get the number of tasks matching the given query
long	countWorkflows(WorkflowInstanceQuery workflowInstanceQuery) Get count of workflow instances
NodeRef	createPackage(NodeRef container) Create a Workflow Package (a container of content to route through the Workflow).
WorkflowInstance	deleteWorkflow(String workflowId) Delete a Workflow instance.
WorkflowDeployment	deployDefinition(NodeRef workflowDefinition) Deploy a Workflow Definition to the Alfresco Repository Note: The specified content object must be of type bpm:workflowdefinition.
WorkflowDeployment	deployDefinition(String engineId, InputStream workflowDefinition, String mimetype) Deploy a Workflow Definition to the Alfresco Repository
WorkflowDeployment	deployDefinition(String engineId, InputStream workflowDefinition, String mimetype, String name) Deploy a Workflow Definition to the Alfresco Repository
WorkflowTask	endTask(String taskId, String transitionId) End the Task (i.e.
WorkflowPath	fireEvent(String pathId, String event) Fire custom event against specified path
List<WorkflowInstance>	getActiveWorkflows() Gets all active workflow instances.
List<WorkflowInstance>	getActiveWorkflows(String workflowDefinitionId) Gets all active workflow instances of the specified Workflow Definition
List<WorkflowDefinition>	getAllDefinitions() Gets all deployed Workflow Definitions (with all previous versions)
List<WorkflowDefinition>	getAllDefinitionsByName(String workflowName) Gets all (including previous) Workflow Definitions for the given unique name
List<WorkflowTask>	getAssignedTasks(String authority, WorkflowTaskState state) Gets all tasks assigned to the specified authority
List<WorkflowTask>	getAssignedTasks(String authority, WorkflowTaskState state, boolean lazyInitialization) Gets all tasks assigned to the specified authority
List<WorkflowInstance>	getCompletedWorkflows() Gets all completed workflow instances.
List<WorkflowInstance>	getCompletedWorkflows(String workflowDefinitionId) Gets all completed workflow instances of the specified Workflow Definition
WorkflowDefinition	getDefinitionById(String workflowDefinitionId) Gets a Workflow Definition by unique Id
WorkflowDefinition	getDefinitionByName(String workflowName) Gets the latest Workflow Definition by unique name
byte[]	getDefinitionImage(String workflowDefinitionId) Gets a graphical view of the Workflow Definition
List<WorkflowDefinition>	getDefinitions() Gets latest deployed Workflow Definitions
List<NodeRef>	getPackageContents(NodeRef packageRef) Get a list of node refs to all the package contents.
List<NodeRef>	getPackageContents(String taskId) Get a list of node refs to all the package contents for the given task id.
Map<QName,Serializable>	getPathProperties(String pathId) Gets the properties associated with the specified path (and parent paths)
List<WorkflowTask>	getPooledTasks(String authority) Gets the pooled tasks available to the specified authority
List<WorkflowTask>	getPooledTasks(String authority, boolean lazyinitialization) Gets the pooled tasks available to the specified authority
WorkflowTask	getStartTask(String workflowInstanceId) Gets the start task instance for the given workflow instance.
List<WorkflowTask>	getStartTasks(List<String> workflowInstanceIds, boolean sameSession) Gets the start task instances for the given workflow instances.
WorkflowTask	getTaskById(String taskId) Gets a Task by unique Id
List<WorkflowTaskDefinition>	getTaskDefinitions(String workflowDefinitionId) Gets the Task Definitions for the given Workflow Definition
List<WorkflowTask>	getTasksForWorkflowPath(String pathId) Gets all Tasks associated with the specified path
List<WorkflowTimer>	getTimers(String workflowId) Gets all active timers for the specified workflow
WorkflowInstance	getWorkflowById(String workflowId) Gets a specific workflow instances
InputStream	getWorkflowImage(String workflowInstanceId) Gets a graphical view of the workflow instance
List<WorkflowPath>	getWorkflowPaths(String workflowId) Gets all Paths for the specified Workflow instance.
List<WorkflowInstance>	getWorkflows() Gets all workflow instances (both active and completed).
List<WorkflowInstance>	getWorkflows(String workflowDefinitionId) Gets all workflow instances (both active and completed) of the specified Workflow Definition
List<WorkflowInstance>	getWorkflows(WorkflowInstanceQuery workflowInstanceQuery) Gets all "in-flight" workflow instances according to the specified workflowInstanceQuery parameter
List<WorkflowInstance>	getWorkflows(WorkflowInstanceQuery workflowInstanceQuery, int maxItems, int skipCount) Gets maxItems "in-flight" workflow instances according to the specified workflowInstanceQuery parameter Get maxItems and skipCount parameters form request
List<WorkflowInstance>	getWorkflowsForContent(NodeRef packageItem, boolean active) Gets the Workflows that act upon the specified Repository content.
boolean	hasWorkflowImage(String workflowInstanceId) Determines if a graphical view of the workflow instance exists
boolean	isDefinitionDeployed(NodeRef workflowDefinition) Is the specified Workflow Definition already deployed? Note: the notion of "already deployed" may differ between bpm engines.
boolean	isDefinitionDeployed(String engineId, InputStream workflowDefinition, String mimetype) Is the specified Workflow Definition already deployed? Note: the notion of "already deployed" may differ between bpm engines.
boolean	isMultiTenantWorkflowDeploymentEnabled()
boolean	isTaskClaimable(WorkflowTask task, String username) Determines if the given user can claim the given task
boolean	isTaskClaimable(WorkflowTask task, String username, boolean refreshTask) Determines if the given user can claim the given task
boolean	isTaskEditable(WorkflowTask task, String username) Determines if the given user can edit the given task
boolean	isTaskEditable(WorkflowTask task, String username, boolean refreshTask) Determines if the given user can edit the given task
boolean	isTaskReassignable(WorkflowTask task, String username) Determines if the given user can reassign the given task
boolean	isTaskReassignable(WorkflowTask task, String username, boolean refreshTask) Determines if the given user can reassign the given task
boolean	isTaskReleasable(WorkflowTask task, String username) Determines if the given user can release the given task
boolean	isTaskReleasable(WorkflowTask task, String username, boolean refreshTask) Determines if the given user can release the given task
List<WorkflowTask>	queryTasks(WorkflowTaskQuery query) Deprecated. Use overloaded method with the sameSession parameter (this method defaults the parameter to false).
List<WorkflowTask>	queryTasks(WorkflowTaskQuery query, boolean sameSession) Query for tasks
WorkflowPath	signal(String pathId, String transitionId) Signal the transition from one Workflow Node to another
WorkflowPath	startWorkflow(String workflowDefinitionId, Map<QName,Serializable> parameters) Start a Workflow Instance
WorkflowPath	startWorkflowFromTemplate(NodeRef templateDefinition) Start a Workflow Instance from an existing "Start Task" template node held in the Repository.
void	undeployDefinition(String workflowDefinitionId) Undeploy an exisiting Workflow Definition TODO: Determine behaviour when "in-flight" workflow instances exist
WorkflowTask	updateTask(String taskId, Map<QName,Serializable> properties, Map<QName,List<NodeRef>> add, Map<QName,List<NodeRef>> remove) Update the Properties and Associations of a Task

@Auditable(parameters={
  "engineId",
  "workflowDefinition",
  "mimetype"
},
           recordable={
  true,
  false,
  true
})
WorkflowDeployment deployDefinition(String engineId,
                                    InputStream workflowDefinition,
                                    String mimetype)

Deploy a Workflow Definition to the Alfresco Repository

engineId - the bpm engine id

workflowDefinition - the workflow definition

mimetype - the mimetype of the workflow definition

workflow deployment descriptor

@Auditable(parameters={
  "engineId",
  "workflowDefinition",
  "mimetype",
  "name"
},
           recordable={
  true,
  false,
  true,
  true
})
WorkflowDeployment deployDefinition(String engineId,
                                    InputStream workflowDefinition,
                                    String mimetype,
                                    String name)

Deploy a Workflow Definition to the Alfresco Repository

engineId - the bpm engine id

workflowDefinition - the workflow definition

mimetype - the mimetype of the workflow definition

name - a name representing the deployment

workflow deployment descriptor

@Auditable(parameters="workflowDefinition")
WorkflowDeployment deployDefinition(NodeRef workflowDefinition)

Deploy a Workflow Definition to the Alfresco Repository Note: The specified content object must be of type bpm:workflowdefinition. This type describes for which BPM engine the definition is appropriate.

workflowDefinition - the content object containing the definition

workflow deployment descriptor

isDefinitionDeployed

@Auditable(parameters="definitionContent")
boolean isDefinitionDeployed(NodeRef workflowDefinition)

Is the specified Workflow Definition already deployed? Note: the notion of "already deployed" may differ between bpm engines. For example, different versions of the same process may be considered equal.

workflowDefinition - the content object containing the definition

true => already deployed

isDefinitionDeployed

@Auditable(parameters={
  "engineId",
  "workflowDefinition",
  "mimetype"
},
           recordable={
  true,
  false,
  true
})
boolean isDefinitionDeployed(String engineId,
                             InputStream workflowDefinition,
                             String mimetype)

engineId - the bpm engine id

workflowDefinition - the definition to check

mimetype - the mimetype of the definition

true => already deployed

@Auditable(parameters="workflowDefinitionId")
void undeployDefinition(String workflowDefinitionId)

Undeploy an exisiting Workflow Definition TODO: Determine behaviour when "in-flight" workflow instances exist

workflowDefinitionId - the id of the definition to undeploy

Gets latest deployed Workflow Definitions

the latest deployed workflow definitions

@Auditable
List<WorkflowDefinition> getAllDefinitions()

Gets all deployed Workflow Definitions (with all previous versions)

the deployed (and previous) workflow definitions

@Auditable(parameters="workflowDefinitionId")
WorkflowDefinition getDefinitionById(String workflowDefinitionId)

Gets a Workflow Definition by unique Id

workflowDefinitionId - the workflow definition id

the deployed workflow definition (or null if not found)

@Auditable(parameters="workflowName")
WorkflowDefinition getDefinitionByName(String workflowName)

Gets the latest Workflow Definition by unique name

workflowName - workflow name e.g. jbpm$wf:review

the deployed workflow definition (or null if not found)

getAllDefinitionsByName

@Auditable(parameters="workflowName")
List<WorkflowDefinition> getAllDefinitionsByName(String workflowName)

Gets all (including previous) Workflow Definitions for the given unique name

workflowName - workflow name e.g. jbpm$wf:review

the deployed workflow definition (or null if not found)

@Auditable(parameters="workflowDefinitionId")
byte[] getDefinitionImage(String workflowDefinitionId)

Gets a graphical view of the Workflow Definition

workflowDefinitionId - the workflow definition id

image view of the workflow definition

@Auditable(parameters="workflowDefinitionId")
List<WorkflowTaskDefinition> getTaskDefinitions(String workflowDefinitionId)

Gets the Task Definitions for the given Workflow Definition

workflowDefinitionId - the workflow definition id

the deployed task definitions (or null if not found)

@Auditable(parameters={
  "workflowDefinitionId",
  "parameters"
})
WorkflowPath startWorkflow(String workflowDefinitionId,
                           Map<QName,Serializable> parameters)

Start a Workflow Instance

workflowDefinitionId - the workflow definition id

parameters - the initial set of parameters used to populate the "Start Task" properties

the initial workflow path

startWorkflowFromTemplate

@Auditable(parameters="templateDefinition")
WorkflowPath startWorkflowFromTemplate(NodeRef templateDefinition)

Start a Workflow Instance from an existing "Start Task" template node held in the Repository. The node must be of the Type as described in the Workflow Definition.

templateDefinition - the node representing the Start Task properties

the initial workflow path

@Auditable(parameters="workflowDefinitionId")
List<WorkflowInstance> getActiveWorkflows(String workflowDefinitionId)

Gets all active workflow instances of the specified Workflow Definition

workflowDefinitionId - the workflow definition id

the list of "in-flight" workflow instances

getCompletedWorkflows

@Auditable(parameters="workflowDefinitionId")
List<WorkflowInstance> getCompletedWorkflows(String workflowDefinitionId)

Gets all completed workflow instances of the specified Workflow Definition

workflowDefinitionId - the workflow definition id

the list of "in-flight" workflow instances

@Auditable(parameters="workflowDefinitionId")
List<WorkflowInstance> getWorkflows(String workflowDefinitionId)

Gets all workflow instances (both active and completed) of the specified Workflow Definition

workflowDefinitionId - the workflow definition id

the list of "in-flight" workflow instances

List<WorkflowInstance> getWorkflows(WorkflowInstanceQuery workflowInstanceQuery)

Gets all "in-flight" workflow instances according to the specified workflowInstanceQuery parameter

workflowInstanceQuery - WorkflowInstanceQuery

List<WorkflowInstance> getWorkflows(WorkflowInstanceQuery workflowInstanceQuery,
int maxItems,
int skipCount)

Gets maxItems "in-flight" workflow instances according to the specified workflowInstanceQuery parameter Get maxItems and skipCount parameters form request

workflowInstanceQuery - WorkflowInstanceQuery

maxItems workflow instances

long countWorkflows(WorkflowInstanceQuery workflowInstanceQuery)

Get count of workflow instances

workflowInstanceQuery - WorkflowInstanceQuery

count of workflow instances

@Auditable
List<WorkflowInstance> getActiveWorkflows()

Gets all active workflow instances.

the list of "in-flight" workflow instances

getCompletedWorkflows

@Auditable
List<WorkflowInstance> getCompletedWorkflows()

Gets all completed workflow instances.

the list of "in-flight" workflow instances

List<WorkflowInstance> getWorkflows()

Gets all workflow instances (both active and completed).

the list of "in-flight" workflow instances

@Auditable(parameters="workflowId")
WorkflowInstance getWorkflowById(String workflowId)

Gets a specific workflow instances

workflowId - the id of the workflow to retrieve

the workflow instance (or null if not found)

@Auditable(parameters="workflowId")
List<WorkflowPath> getWorkflowPaths(String workflowId)

Gets all Paths for the specified Workflow instance. NOTE: It only returns information for an active Workflow instance.

workflowId - workflow instance id

the list of workflow paths

@Auditable(parameters="pathId")
Map<QName,Serializable> getPathProperties(String pathId)

Gets the properties associated with the specified path (and parent paths)

pathId - workflow path id

map of path properties

@Auditable(parameters="workflowId")
WorkflowInstance cancelWorkflow(String workflowId)

Cancel an "in-flight" Workflow instance

workflowId - the workflow instance to cancel

an updated representation of the workflow instance

@Auditable(parameters="workflowIds")
List<WorkflowInstance> cancelWorkflows(List<String> workflowIds)

Cancel a batch of "in-flight" Workflow instances

workflowIds - List of the workflow instances to cancel

List of updated representations of the workflow instances

@Auditable(parameters="workflowId")
WorkflowInstance deleteWorkflow(String workflowId)

Delete a Workflow instance. NOTE: This will force a delete, meaning that the workflow instance may not go through all the appropriate cancel events.

workflowId - the workflow instance to cancel

an updated representation of the workflow instance

@Auditable(parameters={
  "pathId",
  "transitionId"
})
WorkflowPath signal(String pathId,
                    String transitionId)

Signal the transition from one Workflow Node to another

pathId - the workflow path to signal on

transitionId - the transition id to follow (or null, for the default transition)

the updated workflow path

@Auditable(parameters={
  "pathId",
  "event"
})
WorkflowPath fireEvent(String pathId,
                       String event)

Fire custom event against specified path

pathId - the workflow path to fire event on

event - name of event

workflow path (it may have been updated as a result of firing the event

getTasksForWorkflowPath

@Auditable(parameters="pathId")
List<WorkflowTask> getTasksForWorkflowPath(String pathId)

Gets all Tasks associated with the specified path

pathId - the path id

the list of associated tasks

@Auditable(parameters="pathId")
WorkflowTask getStartTask(String workflowInstanceId)

Gets the start task instance for the given workflow instance.

workflowInstanceId - String

@Auditable(parameters="pathIds")
List<WorkflowTask> getStartTasks(List<String> workflowInstanceIds,
boolean sameSession)

Gets the start task instances for the given workflow instances.

workflowInstanceIds - List

sameSession - indicates that the returned WorkflowTask elements will be used in the same session. If true, the returned List will be a lazy loaded list providing greater performance.

@Auditable(parameters="workflowInstanceId")
boolean hasWorkflowImage(String workflowInstanceId)

Determines if a graphical view of the workflow instance exists

workflowInstanceId - the workflow instance id

true if there is a workflow instance diagram available

@Auditable(parameters="workflowInstanceId",
recordReturnedObject=false)
InputStream getWorkflowImage(String workflowInstanceId)

Gets a graphical view of the workflow instance

workflowInstanceId - the workflow instance id

image view of the workflow instance as an InputStream or null if a diagram is not available

@Auditable(parameters="workflowId")
List<WorkflowTimer> getTimers(String workflowId)

Gets all active timers for the specified workflow

the list of active timers

@Auditable(parameters="taskId")
WorkflowTask getTaskById(String taskId)

Gets a Task by unique Id

taskId - the task id

the task (or null, if not found)

@Auditable(parameters={
  "authority",
  "state",
  "lazyInitialization"
})
List<WorkflowTask> getAssignedTasks(String authority,
                                    WorkflowTaskState state,
                                    boolean lazyInitialization)

Gets all tasks assigned to the specified authority

authority - the authority

state - filter by specified workflow task state

lazyInitialization - hint to the underlying workflow-engine to allow returning WorkflowTasks which aren't fully initialized but will be when the required values are required. If true, the returned enities should be used inside of the transaction-boundaries of this service-call. If false, fully initialized entities are returned, just as with getAssignedTasks(String, WorkflowTaskState).
It's a hint to the underlying workflow-engine and may be ignored by the actual implementation.

the list of assigned tasks

@Auditable(parameters={
  "authority",
  "state",
  "lazy"
})
List<WorkflowTask> getAssignedTasks(String authority,
                                    WorkflowTaskState state)

Gets all tasks assigned to the specified authority

authority - the authority

state - filter by specified workflow task state

the list of assigned tasks

@Auditable(parameters="authority")
List<WorkflowTask> getPooledTasks(String authority)

Gets the pooled tasks available to the specified authority

authority - the authority

the list of pooled tasks

@Auditable(parameters="authority")
List<WorkflowTask> getPooledTasks(String authority,
boolean lazyinitialization)

Gets the pooled tasks available to the specified authority

authority - the authority

lazyinitialization - hint to the underlying workflow-engine to allow returning WorkflowTasks which aren't fully initialized but will be when the required values are required. If true, the returned enities should be used inside of the transaction-boundaries of this service-call. If false, fully initialized entities are returned, just as with getPooledTasks(String).
It's a hint to the underlying workflow-engine and may be ignored by the actual implementation.

the list of pooled tasks

Deprecated. Use overloaded method with the sameSession parameter (this method defaults the parameter to false).

@Auditable(parameters="query")
List<WorkflowTask> queryTasks(WorkflowTaskQuery query,
boolean sameSession)

query - the filter by which tasks are queried

sameSession - indicates that the returned WorkflowTask elements will be used in the same session. If true, the returned List will be a lazy loaded list providing greater performance.

the list of tasks matching the specified query

long countTasks(WorkflowTaskQuery workflowTaskQuery)

Get the number of tasks matching the given query

workflowTaskQuery - the filter by which tasks are queried

count of matching tasks

@Auditable(parameters={
  "taskId",
  "properties",
  "add",
  "remove"
})
WorkflowTask updateTask(String taskId,
                        Map<QName,Serializable> properties,
                        Map<QName,List<NodeRef>> add,
                        Map<QName,List<NodeRef>> remove)

Update the Properties and Associations of a Task