atg.workflow
Class WorkflowDescriptor

java.lang.Object
  atg.workflow.ElementDescriptor
      atg.workflow.WorkflowDescriptor

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class WorkflowDescriptor
extends ElementDescriptor

Description of a workflow including all of its tasks.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION

Constructor Summary

WorkflowDescriptor(java.lang.String pProcessName, java.lang.String pSegmentName)
Constructs a WorkflowDescriptor with the given process and segment names.

Method Summary

void	addAsset(atg.workflow.AssetDescriptor pAsset) Adds a new declared asset to this workflow description.
void	addTask(TaskDescriptor pTask) Adds a new task to this workflow description.
protected void	addTaskElementId(TaskDescriptor pTask, java.lang.String pId) Adds a new task element id to this workflow description, enabling the corresponding task to be looked up from that id.
boolean	equals(java.lang.Object o) Determines equality with another WorkflowDescriptor, based on the equality of process and segment names.
AccessControlList	getAccessControlList() Returns the access control list which specifies who is permitted to act on this workflow.
atg.workflow.AssetDescriptor	getAssetByName(java.lang.String pName) Returns an AssetDescriptor for a declared asset in this workflow with the given logical name, or null if no such AssetDescriptor exists.
java.util.List	getAssets() Returns the List of assets declared in this workflow.
java.lang.String	getFormURI() Returns the URI of a form which can be used in the UI to solicit workflow-specific data, prior to creating this workflow.
java.lang.String	getProcessName() Returns the name of the workflow process.
java.lang.String	getSegmentName() Returns the name of the workflow process segment.
TaskDescriptor	getTaskByElementId(java.lang.String pTaskElementId) Returns a TaskDescriptor for a task in this workflow with the given element id, or null if no such TaskDescriptor exists.
TaskDescriptor	getTaskByName(java.lang.String pName) Returns a TaskDescriptor for a task in this workflow with the given logical name, or null if no such TaskDescriptor exists.
java.util.List	getTasks() Returns the List of tasks for this workflow, in presentation order.
int	hashCode() Computes the hash code for this WorkflowDescriptor.
void	setAccessControlList(AccessControlList pAcl) Sets the access control list which specifies who is permitted to act on this workflow.
void	setFormURI(java.lang.String pFormURI) Sets the URI of a form which can be used in the UI to solicit workflow-specific data, prior to creating this workflow.
void	setProcessName(java.lang.String pProcessName) Sets the name of the workflow process.
void	setSegmentName(java.lang.String pSegmentName) Sets the name of the workflow process segment.
java.lang.String	toString() Returns a String representation of this WorkflowDescriptor.

Methods inherited from class atg.workflow.ElementDescriptor

addDescription, addDisplayName, compareTo, getDescription, getDescription, getDescriptionResource, getDisplayName, getDisplayName, getDisplayNameResource, getName, getPresentationOrdinal, getResourceBundle, getResourceBundleName, setDescription, setDescriptionResource, setDisplayName, setDisplayNameResource, setName, setPresentationOrdinal, setResourceBundleName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

WorkflowDescriptor

public WorkflowDescriptor(java.lang.String pProcessName,
                          java.lang.String pSegmentName)

Constructs a WorkflowDescriptor with the given process and segment names. The rest of the properties remain unset and must be subsequently filled in.

Parameters:

pProcessName - the name of the workflow process

pSegmentName - the name of the workflow process segment

Method Detail

getProcessName

public java.lang.String getProcessName()

Returns the name of the workflow process.

setProcessName

public void setProcessName(java.lang.String pProcessName)

Sets the name of the workflow process.

getSegmentName

public java.lang.String getSegmentName()

Returns the name of the workflow process segment.

setSegmentName

public void setSegmentName(java.lang.String pSegmentName)

Sets the name of the workflow process segment.

getFormURI

public java.lang.String getFormURI()

Returns the URI of a form which can be used in the UI to solicit workflow-specific data, prior to creating this workflow. If null, then no data need be solicited.

See Also:

OutcomeDescriptor.getFormURI()

setFormURI

public void setFormURI(java.lang.String pFormURI)

Sets the URI of a form which can be used in the UI to solicit workflow-specific data, prior to creating this workflow.

getAccessControlList

public AccessControlList getAccessControlList()

Returns the access control list which specifies who is permitted to act on this workflow. If null, then no security checks are required.

setAccessControlList

public void setAccessControlList(AccessControlList pAcl)

Sets the access control list which specifies who is permitted to act on this workflow.

addTask

public void addTask(TaskDescriptor pTask)

Adds a new task to this workflow description.

Parameters:

pTask - a TaskDescriptor for the task to be added

addTaskElementId

protected void addTaskElementId(TaskDescriptor pTask,
                                java.lang.String pId)

Adds a new task element id to this workflow description, enabling the corresponding task to be looked up from that id.

getTasks

public java.util.List getTasks()

Returns the List of tasks for this workflow, in presentation order.

Returns:

a List of TaskDescriptor objects corresponding to this workflow's tasks

See Also:

TaskDescriptor

getTaskByElementId

public TaskDescriptor getTaskByElementId(java.lang.String pTaskElementId)

Returns a TaskDescriptor for a task in this workflow with the given element id, or null if no such TaskDescriptor exists. The element id can also refer to an outcome element associated with the desired task.

Parameters:

pTaskElementId - the process element id of the task element, or one of the task's outcome elements, as it appears in the workflow definition file

getTaskByName

public TaskDescriptor getTaskByName(java.lang.String pName)

Returns a TaskDescriptor for a task in this workflow with the given logical name, or null if no such TaskDescriptor exists.

Parameters:

pName - the logical name of the task

addAsset

public void addAsset(atg.workflow.AssetDescriptor pAsset)

Adds a new declared asset to this workflow description.

Parameters:

pAsset - an AssetDescriptor for the asset to be added

getAssets

public java.util.List getAssets()

Returns the List of assets declared in this workflow.

Returns:

a List of AssetDescriptor objects corresponding to this workflow's declared assets

See Also:

AssetDescriptor

getAssetByName

public atg.workflow.AssetDescriptor getAssetByName(java.lang.String pName)

Returns an AssetDescriptor for a declared asset in this workflow with the given logical name, or null if no such AssetDescriptor exists.

Parameters:

pName - the logical name of the asset

equals

public boolean equals(java.lang.Object o)

Determines equality with another WorkflowDescriptor, based on the equality of process and segment names.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Computes the hash code for this WorkflowDescriptor.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Returns a String representation of this WorkflowDescriptor.

Overrides:

toString in class java.lang.Object