Package org.alfresco.repo.workflow.jscript

Class JscriptWorkflowTask

java.lang.Object

org.alfresco.repo.processor.BaseProcessorExtension

org.alfresco.repo.jscript.BaseScopableProcessorExtension

org.alfresco.repo.workflow.jscript.JscriptWorkflowTask

All Implemented Interfaces:

Serializable, ProcessorExtension, Scopeable

public class JscriptWorkflowTask
extends BaseScopableProcessorExtension
implements Serializable

This class represents a workflow task (an instance of a workflow task definition)

Author:

glenj, Nick Smith

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
JscriptWorkflowTask(WorkflowTask task, ServiceRegistry serviceRegistry, org.mozilla.javascript.Scriptable scope)	Creates a new instance of a workflow task from a WorkflowTask from the CMR workflow object model

Method Summary

Modifier and Type	Method	Description
void	endTask(String transitionId)	End the task
String	getDescription()	Gets the value of the description property
String	getId()	Gets the value of the id property
String	getName()	Gets the value of the name property
org.mozilla.javascript.Scriptable	getPackageResources()	Get the packe resources (array of noderefs)
org.mozilla.javascript.Scriptable	getProperties()	Gets the value of the properties property
String	getTitle()	Gets the value of the title property
ScriptableHashMap<String,String>	getTransitions()	Get the available transition ids.
boolean	isComplete()	Returns whether the task is complete 'true':complete, 'false':in-progress
boolean	isPooled()	Returns whether this task is pooled or not
void	setPooled(boolean pooled)	Deprecated. pooled state cannot be altered.
void	setProperties(ScriptableQNameMap<String,Serializable> properties)	Sets the properties on the underlying WorkflowTask.

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

JscriptWorkflowTask

public JscriptWorkflowTask(WorkflowTask task,
                           ServiceRegistry serviceRegistry,
                           org.mozilla.javascript.Scriptable scope)

Creates a new instance of a workflow task from a WorkflowTask from the CMR workflow object model

Parameters:

task - an instance of WorkflowTask from CMR workflow object model

serviceRegistry - Service Registry object

Method Detail

getId

public String getId()

Gets the value of the id property

Returns:

the id

getName

public String getName()

Gets the value of the name property

Returns:

the name

getTitle

public String getTitle()

Gets the value of the title property

Returns:

the title

getDescription

public String getDescription()

Gets the value of the description property

Returns:

the description

getProperties

public org.mozilla.javascript.Scriptable getProperties()

Gets the value of the properties property

Returns:

the properties

setProperties

public void setProperties(ScriptableQNameMap<String,Serializable> properties)

Sets the properties on the underlying WorkflowTask.

Parameters:

properties - the properties to set

isComplete

public boolean isComplete()

Returns whether the task is complete 'true':complete, 'false':in-progress

Returns:

the complete

isPooled

public boolean isPooled()

Returns whether this task is pooled or not

Returns:

'true': task is pooled, 'false': task is not pooled

setPooled

@Deprecated
public void setPooled(boolean pooled)

Deprecated.

pooled state cannot be altered.

endTask

public void endTask(String transitionId)

End the task

Parameters:

transitionId - transition to end the task for

getTransitions

public ScriptableHashMap<String,String> getTransitions()

Get the available transition ids.

Returns:

ScriptableHashMap

getPackageResources

public org.mozilla.javascript.Scriptable getPackageResources()

Get the packe resources (array of noderefs)

Returns:

Scriptable