atg.workflow

Class OutcomeDescriptor

java.lang.Object

atg.workflow.ElementDescriptor

atg.workflow.OutcomeDescriptor

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public class OutcomeDescriptor
extends ElementDescriptor

Description of an outcome for some task as specified in a workflow.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
OutcomeDescriptor(TaskDescriptor pTask, java.lang.String pOutcomeElementId, java.lang.String pName) Constructs an OutcomeDescriptor with the given task, outcome element id, and name.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Determines equality with another OutcomeDescriptor.
java.lang.String	getFormURI() Returns the URI of a form which can be used in the UI to solicit outcome-specific data, prior to firing this outcome.
java.lang.String	getOutcomeElementId() Returns the process element id of the outcome element in the workflow, as it appears in the workflow definition file.
java.lang.String	getResourceBundleName() If resourceBundleName is null will return the workflow descriptors resourceBundleName.
TaskDescriptor	getTask() Returns the TaskDescriptor for the task to which this outcome belongs.
int	hashCode() Computes the hash code for this OutcomeDescriptor.
void	setFormURI(java.lang.String pFormURI) Sets the URI of a form which can be used in the UI to solicit outcome-specific data, prior to firing this outcome.
void	setOutcomeElementId(java.lang.String pOutcomeElementId) Sets the process element id of the outcome element in the workflow.
java.lang.String	toString() Returns a String representation of this OutcomeDescriptor.

Methods inherited from class atg.workflow.ElementDescriptor

addDescription, addDisplayName, compareTo, getDescription, getDescription, getDescriptionResource, getDisplayName, getDisplayName, getDisplayNameResource, getName, getPresentationOrdinal, getResourceBundle, 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

OutcomeDescriptor

public OutcomeDescriptor(TaskDescriptor pTask,
                         java.lang.String pOutcomeElementId,
                         java.lang.String pName)

Constructs an OutcomeDescriptor with the given task, outcome element id, and name. The rest of the properties remain unset and must be subsequently filled in.

Parameters:

pTask - the TaskDescriptor for the task to which this outcome belongs

pOutcomeElementId - process element id of the outcome element, as it appears in the workflow definition file

pName - the logical name of this element

Method Detail

getTask

public TaskDescriptor getTask()

Returns the TaskDescriptor for the task to which this outcome belongs.

getOutcomeElementId

public java.lang.String getOutcomeElementId()

Returns the process element id of the outcome element in the workflow, as it appears in the workflow definition file.

setOutcomeElementId

public void setOutcomeElementId(java.lang.String pOutcomeElementId)

Sets the process element id of the outcome element in the workflow.

getFormURI

public java.lang.String getFormURI()

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

As an example, in a workflow where an approver may choose to reject a particular transaction, one might want him or her to supply some additional information along with clicking the "Reject" button, such as a reason for the rejection. This information could be supplied via a separate JSP form.

setFormURI

public void setFormURI(java.lang.String pFormURI)

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

equals

public boolean equals(java.lang.Object o)

Determines equality with another OutcomeDescriptor. This method only tests element ids associated with the two OutcomeDescriptors, not any other attributes.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Computes the hash code for this OutcomeDescriptor.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Returns a String representation of this OutcomeDescriptor.

Overrides:

toString in class java.lang.Object

getResourceBundleName

public java.lang.String getResourceBundleName()

If resourceBundleName is null will return the workflow descriptors resourceBundleName.

Overrides:

getResourceBundleName in class ElementDescriptor