|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.workflow.ElementDescriptor
public abstract class ElementDescriptor
Description of some element of a workflow.
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 |
getDescriptionResource()
Returns the description resource key |
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 |
getDisplayNameResource()
Returns the displayName resource key |
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. |
java.util.ResourceBundle |
getResourceBundle(java.util.Locale pLocale)
Returns a layered resource bundle |
java.lang.String |
getResourceBundleName()
Returns the resource bundle name string |
void |
setDescription(java.lang.String pDescription)
Sets the default short description. |
void |
setDescriptionResource(java.lang.String pDescriptionResource)
Sets the description resource key |
void |
setDisplayName(java.lang.String pDisplayName)
Sets the default display name. |
void |
setDisplayNameResource(java.lang.String pDisplayNameResource)
Sets the displayName resource key |
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. |
void |
setResourceBundleName(java.lang.String pResourceBundleName)
Sets the resource bundle name |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public ElementDescriptor(java.lang.String pName)
Method Detail |
---|
public java.lang.String getName()
public void setName(java.lang.String pName)
public java.lang.String getDisplayName()
public void setDisplayName(java.lang.String pDisplayName)
public java.lang.String getDisplayName(java.util.Locale pLocale)
pLocale
- the locale for which the display name is desired
public void addDisplayName(java.lang.String pDisplayName, java.lang.String pLocaleString)
pDisplayName
- the display name to addpLocaleString
- the locale string under which the display
name will be stored, e.g. "en" or "en_US"public java.lang.String getDescription()
public void setDescription(java.lang.String pDescription)
public java.lang.String getDescription(java.util.Locale pLocale)
pLocale
- the locale for which the description is desired
public void addDescription(java.lang.String pDescription, java.lang.String pLocaleString)
pDescription
- the short description to addpLocaleString
- the locale string under which the
description will be stored, e.g. "en" or "en_US"public int getPresentationOrdinal()
public void setPresentationOrdinal(int pPresentationOrdinal)
public java.util.ResourceBundle getResourceBundle(java.util.Locale pLocale)
public java.lang.String getResourceBundleName()
public void setResourceBundleName(java.lang.String pResourceBundleName)
public java.lang.String getDisplayNameResource()
public void setDisplayNameResource(java.lang.String pDisplayNameResource)
public java.lang.String getDescriptionResource()
public void setDescriptionResource(java.lang.String pDescriptionResource)
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |