atg.workflow
Class ElementDescriptor

java.lang.Object
  atg.workflow.ElementDescriptor

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Direct Known Subclasses:

OutcomeDescriptor, TaskDescriptor, WorkflowDescriptor

public abstract class ElementDescriptor
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable

Description of some element of a workflow.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION

Constructor Summary

ElementDescriptor(java.lang.String pName)
Constructs an ElementDescriptor with the given logical name.

Method Summary

void	addDescription(java.lang.String pDescription, java.lang.String pLocaleString) Stores a short description for this element under a given locale string.
void	addDisplayName(java.lang.String pDisplayName, java.lang.String pLocaleString) Stores a display name for this element under a given locale string.
int	compareTo(java.lang.Object o) Compares this ElementDescriptor with another ElementDescriptor.
java.lang.String	getDescription() Returns the default short description.
java.lang.String	getDescription(java.util.Locale pLocale) Returns the short description of this element for the given Locale.
java.lang.String	getDisplayName() Returns the default display name.
java.lang.String	getDisplayName(java.util.Locale pLocale) Returns the display name of this element for the given Locale.
java.lang.String	getName() Returns the logical name of this element.
int	getPresentationOrdinal() Returns an integer that can be used to sort ElementDescriptors for presentation.
void	setDescription(java.lang.String pDescription) Sets the default short description.
void	setDisplayName(java.lang.String pDisplayName) Sets the default display name.
void	setName(java.lang.String pName) Sets the logical name of this element.
void	setPresentationOrdinal(int pPresentationOrdinal) Sets an integer that can be used to sort ElementDescriptors for presentation.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

ElementDescriptor

public ElementDescriptor(java.lang.String pName)

Constructs an ElementDescriptor with the given logical name.

Method Detail

getName

public java.lang.String getName()

Returns the logical name of this element.

setName

public void setName(java.lang.String pName)

Sets the logical name of this element.

getDisplayName

public java.lang.String getDisplayName()

Returns the default display name.

setDisplayName

public void setDisplayName(java.lang.String pDisplayName)

Sets the default display name.

getDisplayName

public java.lang.String getDisplayName(java.util.Locale pLocale)

Returns the display name of this element for the given Locale.

Parameters:

pLocale - the locale for which the display name is desired

Returns:

the workflow's localized display name

addDisplayName

public void addDisplayName(java.lang.String pDisplayName,
                           java.lang.String pLocaleString)

Stores a display name for this element under a given locale string.

Parameters:

pDisplayName - the display name to add

pLocaleString - the locale string under which the display name will be stored, e.g. "en" or "en_US"

getDescription

public java.lang.String getDescription()

Returns the default short description.

setDescription

public void setDescription(java.lang.String pDescription)

Sets the default short description.

getDescription

public java.lang.String getDescription(java.util.Locale pLocale)

Returns the short description of this element for the given Locale.

Parameters:

pLocale - the locale for which the description is desired

Returns:

the workflow's localized short description

addDescription

public void addDescription(java.lang.String pDescription,
                           java.lang.String pLocaleString)

Stores a short description for this element under a given locale string.

Parameters:

pDescription - the short description to add

pLocaleString - the locale string under which the description will be stored, e.g. "en" or "en_US"

getPresentationOrdinal

public int getPresentationOrdinal()

Returns an integer that can be used to sort ElementDescriptors for presentation.

setPresentationOrdinal

public void setPresentationOrdinal(int pPresentationOrdinal)

Sets an integer that can be used to sort ElementDescriptors for presentation.

compareTo

public int compareTo(java.lang.Object o)

Compares this ElementDescriptor with another ElementDescriptor. The descriptors are compared using their presentation ordinals. Returns a negative integer, zero, or a positive integer depending on whether this ElementDescriptor's ordinal is less than, equal to, or greater than the ordinal of the specified ElementDescriptor.

Specified by:

compareTo in interface java.lang.Comparable