org.alfresco.repo.workflow.jscript

Class WorkflowManager

java.lang.Object

org.alfresco.repo.processor.BaseProcessorExtension

org.alfresco.repo.jscript.BaseScopableProcessorExtension

org.alfresco.repo.workflow.jscript.WorkflowManager

All Implemented Interfaces:

org.alfresco.processor.ProcessorExtension, Scopeable

public class WorkflowManager
extends BaseScopableProcessorExtension

The Workflow Manager serves as the main entry point for scripts to create and interact with workflows. It is made available in the root scripting scope

Author:

glenj

Constructor Summary

Constructors

Constructor and Description
WorkflowManager()

Method Summary

Modifier and Type	Method and Description
ScriptNode	createPackage() Create a workflow package (a container of content to route through a workflow)
org.mozilla.javascript.Scriptable	getAllDefinitions() Gets all versions of the deployed workflow definitions
org.mozilla.javascript.Scriptable	getAssignedTasks() Get tasks assigned to the current user.
org.mozilla.javascript.Scriptable	getCompletedTasks() Get completed tasks assigned to the current user.
JscriptWorkflowDefinition	getDefinition(String id) Get deployed workflow definition by ID
JscriptWorkflowDefinition	getDefinitionByName(String name) Get deployed workflow definition by Name
JscriptWorkflowInstance	getInstance(String workflowInstanceID) Get Workflow Instance by ID
org.mozilla.javascript.Scriptable	getLatestDefinitions() Gets the latest versions of the deployed, workflow definitions
int	getMaxGroupReviewers()
org.mozilla.javascript.Scriptable	getPooledTasks(String authority) Get pooled tasks
JscriptWorkflowTask	getTask(String id) Get task by id
JscriptWorkflowTask	getTaskById(String id) Get task by id.
void	setMaxGroupReviewers(int maxGroupReviewers)
void	setServiceRegistry(ServiceRegistry services) Sets the Service Registry property

Methods inherited from class org.alfresco.repo.jscript.BaseScopableProcessorExtension

getScope, setScope

Methods inherited from class org.alfresco.repo.processor.BaseProcessorExtension

getExtensionName, register, setExtensionName, setProcessor

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowManager

public WorkflowManager()

Method Detail

setServiceRegistry

public void setServiceRegistry(ServiceRegistry services)

Sets the Service Registry property

Parameters:

services - the service registry

setMaxGroupReviewers

public void setMaxGroupReviewers(int maxGroupReviewers)

getMaxGroupReviewers

public int getMaxGroupReviewers()

getDefinition

public JscriptWorkflowDefinition getDefinition(String id)

Get deployed workflow definition by ID

Parameters:

id - the workflow definition ID

Returns:

the workflow definition matching the given ID

getDefinitionByName

public JscriptWorkflowDefinition getDefinitionByName(String name)

Get deployed workflow definition by Name

Parameters:

name - the workflow definition name

Returns:

the workflow definition matching the given name

getAssignedTasks

public org.mozilla.javascript.Scriptable getAssignedTasks()

Get tasks assigned to the current user. Note that this will only return in-progress tasks.

Returns:

the list of assigned (in-progress) tasks

getCompletedTasks

public org.mozilla.javascript.Scriptable getCompletedTasks()

Get completed tasks assigned to the current user.

Returns:

the list of completed tasks

getInstance

public JscriptWorkflowInstance getInstance(String workflowInstanceID)

Get Workflow Instance by ID

Parameters:

workflowInstanceID - ID of the workflow instance to retrieve

Returns:

the workflow instance for the given ID

getPooledTasks

public org.mozilla.javascript.Scriptable getPooledTasks(String authority)

Get pooled tasks

Parameters:

authority - the authority

Returns:

the list of assigned tasks

getTask

public JscriptWorkflowTask getTask(String id)

Get task by id

Parameters:

id - task id

Returns:

the task (null if not found)

getTaskById

public JscriptWorkflowTask getTaskById(String id)

Get task by id. Alternative method signature to getTask(String id) for those used to the Template API

Parameters:

id - task id

Returns:

the task (null if not found)

getLatestDefinitions

public org.mozilla.javascript.Scriptable getLatestDefinitions()

Gets the latest versions of the deployed, workflow definitions

Returns:

the latest versions of the deployed workflow definitions

getAllDefinitions

public org.mozilla.javascript.Scriptable getAllDefinitions()

Gets all versions of the deployed workflow definitions

Returns:

all versions of the deployed workflow definitions

createPackage

public ScriptNode createPackage()

Create a workflow package (a container of content to route through a workflow)

Returns:

the created workflow package