|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.workflow.ElementDescriptor atg.workflow.WorkflowDescriptor
public class WorkflowDescriptor
Description of a workflow including all of its tasks.
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, getDisplayName, getDisplayName, getName, getPresentationOrdinal, setDescription, setDisplayName, setName, setPresentationOrdinal |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public WorkflowDescriptor(java.lang.String pProcessName, java.lang.String pSegmentName)
pProcessName
- the name of the workflow processpSegmentName
- the name of the workflow process segmentMethod Detail |
---|
public java.lang.String getProcessName()
public void setProcessName(java.lang.String pProcessName)
public java.lang.String getSegmentName()
public void setSegmentName(java.lang.String pSegmentName)
public java.lang.String getFormURI()
OutcomeDescriptor.getFormURI()
public void setFormURI(java.lang.String pFormURI)
public AccessControlList getAccessControlList()
public void setAccessControlList(AccessControlList pAcl)
public void addTask(TaskDescriptor pTask)
pTask
- a TaskDescriptor for the task to be addedprotected void addTaskElementId(TaskDescriptor pTask, java.lang.String pId)
public java.util.List getTasks()
TaskDescriptor
public TaskDescriptor getTaskByElementId(java.lang.String pTaskElementId)
pTaskElementId
- the process element id of the task element,
or one of the task's outcome elements, as it appears in the
workflow definition filepublic TaskDescriptor getTaskByName(java.lang.String pName)
pName
- the logical name of the taskpublic void addAsset(atg.workflow.AssetDescriptor pAsset)
pAsset
- an AssetDescriptor for the asset to be addedpublic java.util.List getAssets()
AssetDescriptor
public atg.workflow.AssetDescriptor getAssetByName(java.lang.String pName)
pName
- the logical name of the assetpublic boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |