public class ProcessTemplateBean extends java.lang.Object implements ProcessTemplateData
Accesses the properties of the original ProcessTemplateData
object
and adds metadata for national language support and converters.
A ProcessTemplateBean
object can be instantiated from a ProcessTemplateData
object.
Use the static method getLabel(String, Locale)
to
retrieve the localized label for a property.
Use the static method getConverter(String)
to
retrieve a converter for a property. The return value might be null, as converters
are optional.
ProcessTemplateData
,
Serialized FormModifier and Type | Field and Description |
---|---|
static java.lang.String |
APPLICATIONNAME_PROPERTY
Use the property name to determine labels and converters for the
applicationName property. |
static java.lang.String |
AUTO_DELETION_MODE
Use the property name to determine labels and converters for the
autoDeletionMode property. |
static java.lang.String |
AUTODELETE_PROPERTY
Use the property name to determine labels and converters for the
autoDelete property. |
static java.lang.String |
AUTONOMY_PROPERTY
Use the property name to determine labels and converters for the
autonomy property. |
static java.lang.String |
AVAILABLEACTIONS_PROPERTY
Use the property name to determine labels and converters for the
availableActions property. |
static java.lang.String |
COMPENSATIONDEFINED_PROPERTY
Use the property name to determine labels and converters for the
compensationDefined property. |
static java.lang.String |
CONTINUEONERROR_PROPERTY
Use the property name to determine labels and converters for the
continueOnError property. |
static java.lang.String |
COPYRIGHT
(C) Copyright IBM Corporation 2005, 2011.
|
static java.lang.String |
CREATIONTIME_PROPERTY
Use the property name to determine labels and converters for the
creationTime property. |
static java.lang.String |
CUSTOMTEXT1_PROPERTY
Use the property name to determine labels and converters for the
customText1 property. |
static java.lang.String |
CUSTOMTEXT2_PROPERTY
Use the property name to determine labels and converters for the
customText2 property. |
static java.lang.String |
CUSTOMTEXT3_PROPERTY
Use the property name to determine labels and converters for the
customText1 property. |
static java.lang.String |
CUSTOMTEXT4_PROPERTY
Use the property name to determine labels and converters for the
customText1 property. |
static java.lang.String |
CUSTOMTEXT5_PROPERTY
Use the property name to determine labels and converters for the
customText1 property. |
static java.lang.String |
CUSTOMTEXT6_PROPERTY
Use the property name to determine labels and converters for the
customText1 property. |
static java.lang.String |
CUSTOMTEXT7_PROPERTY
Use the property name to determine labels and converters for the
customText1 property. |
static java.lang.String |
CUSTOMTEXT8_PROPERTY
Use the property name to determine labels and converters for the
customText1 property. |
static java.lang.String |
DESCRIPTION_PROPERTY
Use the property name to determine labels and converters for the
description property. |
static java.lang.String |
DISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the
displayName property. |
static java.lang.String |
DOCUMENTATION_PROPERTY
Use the property name to determine labels and converters for the
documentation property. |
static java.lang.String |
EXECUTIONMODE_PROPERTY
Use the property name to determine labels and converters for the
executionMode property. |
static java.lang.String |
ID_PROPERTY
Use the property name to determine labels and converters for the
ID property. |
static java.lang.String |
INPUTMESSAGETYPENAME_PROPERTY
Use the property name to determine labels and converters for the
inputMessageTypeName property. |
static java.lang.String |
INPUTMESSAGETYPETYPESYSTEM_PROPERTY
Deprecated.
|
static java.lang.String |
LASTMODIFICATIONTIME_PROPERTY
Use the property name to determine labels and converters for the
lastModificationTime property. |
static java.lang.String |
NAME_PROPERTY
Use the property name to determine labels and converters for the
name property. |
static java.lang.String |
OUTPUTMESSAGETYPENAME_PROPERTY
Use the property name to determine labels and converters for the
outputMessageTypeName property. |
static java.lang.String |
OUTPUTMESSAGETYPETYPESYSTEM_PROPERTY
Deprecated.
|
static java.lang.String |
PROCESSADMINSTRATORS_PROPERTY
Deprecated.
|
static java.lang.String |
PROCESSAPPACRONYM_PROPERTY
Use the property name to determine labels and converters for the
processAppAcronym property. |
static java.lang.String |
PROCESSAPPNAME_PROPERTY
Use the property name to determine labels and converters for the
processAppName property. |
static java.lang.String |
SCHEMAVERSION_PROPERTY
Use the property name to determine labels and converters for the
schemaVersion property. |
static java.lang.String |
SNAPSHOTID_PROPERTY
Use the property name to determine labels and converters for the
snapshotID property. |
static java.lang.String |
SNAPSHOTNAME_PROPERTY
Use the property name to determine labels and converters for the
snapshotName property. |
static java.lang.String |
STATE_PROPERTY
Use the property name to determine labels and converters for the
state property. |
static java.lang.String |
TARGETNAMESPACE_PROPERTY
Use the property name to determine labels and converters for the
targetNamespace property. |
static java.lang.String |
TIP_PROPERTY
Use the property name to determine labels and converters for the
tip property. |
static java.lang.String |
TOOLKITACRONYM_PROPERTY
Use the property name to determine labels and converters for the
toolkitAcronym property. |
static java.lang.String |
TOOLKITNAME_PROPERTY
Use the property name to determine labels and converters for the
toolkitName property. |
static java.lang.String |
TOOLKITSNAPSHOTID_PROPERTY
Use the property name to determine labels and converters for the
toolkitSnapshotID property. |
static java.lang.String |
TOOLKITSNAPSHOTNAME_PROPERTY
Use the property name to determine labels and converters for the
toolkitSnapshotName property. |
static java.lang.String |
TOPLEVELTOOLKITACRONYM_PROPERTY
Use the property name to determine labels and converters for the
topLevelToolkitAcronym property. |
static java.lang.String |
TOPLEVELTOOLKITNAME_PROPERTY
Use the property name to determine labels and converters for the
topLevelToolkitName property. |
static java.lang.String |
TRACKNAME_PROPERTY
Use the property name to determine labels and converters for the
trackName property. |
static java.lang.String |
VALIDFROMTIME_PROPERTY
Use the property name to determine labels and converters for the
validFromTime property. |
static java.lang.String |
VERSION_PROPERTY
Use the property name to determine labels and converters for the
version property. |
AUTO_DELETE_NO, AUTO_DELETE_ON_SUCCESSFUL_COMPLETION, AUTO_DELETE_YES, AUTONOMY_CHILD, AUTONOMY_NOT_APPLICABLE, AUTONOMY_PEER, EXECUTION_MODE_LONG_RUNNING, EXECUTION_MODE_MICROFLOW, KIND_BLOCK, KIND_PROCESS, SCHEMA_5_1, SCHEMA_5_1_1, SCHEMA_6_0, SCHEMA_6_0_2, SCHEMA_6_1, SCHEMA_6_1_2, SCHEMA_6_2, SCHEMA_7_0, SCHEMA_7_5_0, SCHEMA_7_5_1, STATE_MARKED_FOR_DELETION, STATE_STARTED, STATE_STOPPED
Constructor and Description |
---|
ProcessTemplateBean(ProcessTemplateData data,
BFMConnection bfmConnection)
Constructs a new
ProcessTemplateBean from an original
ProcessTemplateData object. |
ProcessTemplateBean(PTID id,
BFMConnection bfmConnection)
Constructs a new
ProcessTemplateBean from a process template id. |
Modifier and Type | Method and Description |
---|---|
java.util.List |
getActivityServiceTemplates()
Returns the list of starting activities for the process template.
|
TKTID |
getAdminTaskTemplateID()
Returns the property
adminTaskTemplateID . |
java.lang.String |
getApplicationName()
Returns the property
applicationName . |
boolean |
getAutoDelete()
Deprecated.
|
int |
getAutoDeletionMode()
Returns the property
autoDeletionMode . |
int |
getAutonomy()
Returns the property
autonomy . |
int[] |
getAvailableActions()
Returns the property
availableActions . |
static SimpleConverter |
getConverter(java.lang.String propertyName)
Returns the default converter for a given property.
|
java.util.Calendar |
getCreationTime()
Returns the property
creationTime . |
java.lang.String |
getCustomText1()
Returns the property
customText1 . |
java.lang.String |
getCustomText2()
Returns the property
customText2 . |
java.lang.String |
getCustomText3()
Returns the property
customText3 . |
java.lang.String |
getCustomText4()
Returns the property
customText4 . |
java.lang.String |
getCustomText5()
Returns the property
customText5 . |
java.lang.String |
getCustomText6()
Returns the property
customText6 . |
java.lang.String |
getCustomText7()
Returns the property
customText7 . |
java.lang.String |
getCustomText8()
Returns the property
customText8 . |
java.lang.String |
getDescription()
Returns the property
description . |
java.lang.String |
getDisplayName()
Returns the property
displayName . |
java.lang.String |
getDocumentation()
Returns the property
documentation . |
int |
getExecutionMode()
Returns the property
executionMode . |
PTID |
getID()
Returns the property
ID . |
java.lang.String |
getInputMessageTypeName()
Returns the property
inputMessageTypeName . |
java.lang.String |
getInputMessageTypeTypeSystemName()
Deprecated.
|
static java.lang.String |
getLabel(java.lang.String propertyName)
Returns the resource bundle key for a property
|
static java.lang.String |
getLabel(java.lang.String propertyName,
java.util.Locale locale)
Returns the label for a property from the resource bundle.
|
java.util.Calendar |
getLastModificationTime()
Returns the property
lastModificationTime . |
java.lang.String |
getName()
Returns the property
name . |
java.lang.String |
getOutputMessageTypeName()
Returns the property
outputMessageTypeName . |
java.lang.String |
getOutputMessageTypeTypeSystemName()
Deprecated.
|
StaffResultSet |
getProcessAdministrators()
Deprecated.
|
java.lang.String |
getProcessAppAcronym()
Returns the
processAppAcronym property. |
java.lang.String |
getProcessAppName()
Returns the
processAppName property. |
int |
getSchemaVersion()
Returns the property
schemaVersion . |
java.lang.String |
getSnapshotID()
Returns the
snapshotID property. |
java.lang.String |
getSnapshotName()
Returns the
snapshotName property. |
int |
getState()
Returns the property
state . |
java.lang.String |
getTargetNamespace()
Returns the property
targetNamespace . |
java.lang.String |
getToolkitAcronym()
Returns the
toolkitAcronym property. |
java.lang.String |
getToolkitName()
Returns the
toolkitName property. |
java.lang.String |
getToolkitSnapshotID()
Returns the
toolkitSnapshotID property. |
java.lang.String |
getToolkitSnapshotName()
Returns the
toolkitSnapshotName property. |
java.lang.String |
getTopLevelToolkitAcronym()
Returns the
topLevelToolkitAcronym property. |
java.lang.String |
getTopLevelToolkitName()
Returns the
topLevelToolkitName property. |
java.lang.String |
getTrackName()
Returns the
trackName property. |
java.util.Calendar |
getValidFromTime()
Returns the property
validFromTime . |
java.lang.String |
getVersion()
Returns the property
version . |
boolean |
isBusinessRelevant()
Returns the
businessRelevant property. |
boolean |
isCompensationDefined()
Returns the
compensationDefined property. |
boolean |
isContinueOnError()
Returns the
continueOnError property. |
boolean |
isTip()
Returns the
isTip property. |
static boolean |
isValid(java.lang.String propertyName)
Checks if the property is valid.
|
public static final java.lang.String COPYRIGHT
public static final java.lang.String APPLICATIONNAME_PROPERTY
applicationName
property.public static final java.lang.String AUTODELETE_PROPERTY
autoDelete
property.public static final java.lang.String AUTONOMY_PROPERTY
autonomy
property.public static final java.lang.String AVAILABLEACTIONS_PROPERTY
availableActions
property.public static final java.lang.String COMPENSATIONDEFINED_PROPERTY
compensationDefined
property.public static final java.lang.String CONTINUEONERROR_PROPERTY
continueOnError
property.public static final java.lang.String CREATIONTIME_PROPERTY
creationTime
property.public static final java.lang.String DESCRIPTION_PROPERTY
description
property.public static final java.lang.String DISPLAYNAME_PROPERTY
displayName
property.public static final java.lang.String DOCUMENTATION_PROPERTY
documentation
property.public static final java.lang.String EXECUTIONMODE_PROPERTY
executionMode
property.public static final java.lang.String ID_PROPERTY
ID
property.public static final java.lang.String INPUTMESSAGETYPENAME_PROPERTY
inputMessageTypeName
property.public static final java.lang.String INPUTMESSAGETYPETYPESYSTEM_PROPERTY
inputMessageTypeTypeSystem
property.public static final java.lang.String LASTMODIFICATIONTIME_PROPERTY
lastModificationTime
property.public static final java.lang.String NAME_PROPERTY
name
property.public static final java.lang.String OUTPUTMESSAGETYPENAME_PROPERTY
outputMessageTypeName
property.public static final java.lang.String OUTPUTMESSAGETYPETYPESYSTEM_PROPERTY
outputMessageTypeTypeSystem
property.public static final java.lang.String PROCESSADMINSTRATORS_PROPERTY
processAdministrators
property.public static final java.lang.String SCHEMAVERSION_PROPERTY
schemaVersion
property.public static final java.lang.String STATE_PROPERTY
state
property.public static final java.lang.String VALIDFROMTIME_PROPERTY
validFromTime
property.public static final java.lang.String VERSION_PROPERTY
version
property.public static final java.lang.String AUTO_DELETION_MODE
autoDeletionMode
property.public static final java.lang.String TARGETNAMESPACE_PROPERTY
targetNamespace
property.public static final java.lang.String SNAPSHOTID_PROPERTY
snapshotID
property.public static final java.lang.String SNAPSHOTNAME_PROPERTY
snapshotName
property.public static final java.lang.String TRACKNAME_PROPERTY
trackName
property.public static final java.lang.String PROCESSAPPNAME_PROPERTY
processAppName
property.public static final java.lang.String PROCESSAPPACRONYM_PROPERTY
processAppAcronym
property.public static final java.lang.String TOOLKITSNAPSHOTID_PROPERTY
toolkitSnapshotID
property.public static final java.lang.String TOOLKITSNAPSHOTNAME_PROPERTY
toolkitSnapshotName
property.public static final java.lang.String TOOLKITNAME_PROPERTY
toolkitName
property.public static final java.lang.String TOOLKITACRONYM_PROPERTY
toolkitAcronym
property.public static final java.lang.String TOPLEVELTOOLKITNAME_PROPERTY
topLevelToolkitName
property.public static final java.lang.String TOPLEVELTOOLKITACRONYM_PROPERTY
topLevelToolkitAcronym
property.public static final java.lang.String TIP_PROPERTY
tip
property.public static final java.lang.String CUSTOMTEXT1_PROPERTY
customText1
property.public static final java.lang.String CUSTOMTEXT2_PROPERTY
customText2
property.public static final java.lang.String CUSTOMTEXT3_PROPERTY
customText1
property.public static final java.lang.String CUSTOMTEXT4_PROPERTY
customText1
property.public static final java.lang.String CUSTOMTEXT5_PROPERTY
customText1
property.public static final java.lang.String CUSTOMTEXT6_PROPERTY
customText1
property.public static final java.lang.String CUSTOMTEXT7_PROPERTY
customText1
property.public static final java.lang.String CUSTOMTEXT8_PROPERTY
customText1
property.public ProcessTemplateBean(ProcessTemplateData data, BFMConnection bfmConnection)
ProcessTemplateBean
from an original
ProcessTemplateData
object.data
- The original data object.bfmConnection
- The connection to the BusinessFlowManagerService API.public ProcessTemplateBean(PTID id, BFMConnection bfmConnection)
ProcessTemplateBean
from a process template id.id
- The process template id.bfmConnection
- The connection to the BusinessFlowManagerService API.public static SimpleConverter getConverter(java.lang.String propertyName)
propertyName
- The name for the property.public static java.lang.String getLabel(java.lang.String propertyName)
propertyName
- The name for the property.public static java.lang.String getLabel(java.lang.String propertyName, java.util.Locale locale)
propertyName
- The name for the property.locale
- The locale.public static boolean isValid(java.lang.String propertyName)
propertyName
- The name of the property to be checked.public java.lang.String getApplicationName()
applicationName
.getApplicationName
in interface ProcessTemplateData
ProcessTemplateData.getApplicationName()
public boolean getAutoDelete()
autoDelete
.getAutoDelete
in interface ProcessTemplateData
ProcessTemplateData.getAutoDelete()
public int getAutoDeletionMode()
autoDeletionMode
.getAutoDeletionMode
in interface ProcessTemplateData
ProcessTemplateData.getAutoDeletionMode()
public int getAutonomy()
autonomy
.getAutonomy
in interface ProcessTemplateData
ProcessTemplateData.getAutonomy()
public int[] getAvailableActions()
availableActions
.getAvailableActions
in interface ProcessTemplateData
ProcessTemplateData.getAvailableActions()
public java.util.Calendar getCreationTime()
creationTime
.getCreationTime
in interface ProcessTemplateData
ProcessTemplateData.getCreationTime()
public java.lang.String getDescription()
description
.getDescription
in interface ProcessTemplateData
ProcessTemplateData.getDescription()
public java.lang.String getDisplayName()
displayName
.getDisplayName
in interface ProcessTemplateData
ProcessTemplateData.getDisplayName()
public java.lang.String getDocumentation()
documentation
.getDocumentation
in interface ProcessTemplateData
ProcessTemplateData.getDocumentation()
public int getExecutionMode()
executionMode
.getExecutionMode
in interface ProcessTemplateData
ProcessTemplateData.getExecutionMode()
public PTID getID()
ID
.getID
in interface ProcessTemplateData
ProcessTemplateData.getID()
public java.lang.String getInputMessageTypeName()
inputMessageTypeName
.getInputMessageTypeName
in interface ProcessTemplateData
ProcessTemplateData.getInputMessageTypeName()
public java.lang.String getInputMessageTypeTypeSystemName()
inputMessageTypeTypeSystemName
.getInputMessageTypeTypeSystemName
in interface ProcessTemplateData
ProcessTemplateData.getInputMessageTypeTypeSystemName()
public java.util.Calendar getLastModificationTime()
lastModificationTime
.getLastModificationTime
in interface ProcessTemplateData
ProcessTemplateData.getLastModificationTime()
public java.lang.String getName()
name
.getName
in interface ProcessTemplateData
ProcessTemplateData.getName()
public java.lang.String getOutputMessageTypeName()
outputMessageTypeName
.getOutputMessageTypeName
in interface ProcessTemplateData
ProcessTemplateData.getOutputMessageTypeName()
public java.lang.String getOutputMessageTypeTypeSystemName()
outputMessageTypeTypeSystemName
.getOutputMessageTypeTypeSystemName
in interface ProcessTemplateData
ProcessTemplateData.getOutputMessageTypeTypeSystemName()
public StaffResultSet getProcessAdministrators() throws WorkItemManagerException, InvalidLengthException
processAdministrators
.getProcessAdministrators
in interface ProcessTemplateData
WorkItemManagerException
InvalidLengthException
ProcessTemplateData.getProcessAdministrators()
public int getSchemaVersion()
schemaVersion
.getSchemaVersion
in interface ProcessTemplateData
ProcessTemplateData.getSchemaVersion()
public int getState()
state
.getState
in interface ProcessTemplateData
ProcessTemplateData.getState()
public java.lang.String getTargetNamespace()
targetNamespace
.getTargetNamespace
in interface ProcessTemplateData
ProcessTemplateData.getTargetNamespace()
public java.lang.String getSnapshotID()
snapshotID
property.getSnapshotID
in interface ProcessTemplateData
ProcessTemplateData.getSnapshotID()
public java.lang.String getSnapshotName()
snapshotName
property.getSnapshotName
in interface ProcessTemplateData
ProcessTemplateData.getSnapshotName()
public java.lang.String getTrackName()
trackName
property.getTrackName
in interface ProcessTemplateData
ProcessTemplateData.getTrackName()
public java.lang.String getProcessAppName()
processAppName
property.getProcessAppName
in interface ProcessTemplateData
ProcessTemplateData.getProcessAppName()
public java.lang.String getProcessAppAcronym()
processAppAcronym
property.getProcessAppAcronym
in interface ProcessTemplateData
ProcessTemplateData.getProcessAppAcronym()
public java.lang.String getToolkitSnapshotID()
toolkitSnapshotID
property.getToolkitSnapshotID
in interface ProcessTemplateData
ProcessTemplateData.getToolkitSnapshotID()
public java.lang.String getToolkitSnapshotName()
toolkitSnapshotName
property.getToolkitSnapshotName
in interface ProcessTemplateData
ProcessTemplateData.getToolkitSnapshotName()
public java.lang.String getToolkitName()
toolkitName
property.getToolkitName
in interface ProcessTemplateData
ProcessTemplateData.getToolkitName()
public java.lang.String getToolkitAcronym()
toolkitAcronym
property.getToolkitAcronym
in interface ProcessTemplateData
ProcessTemplateData.getToolkitAcronym()
public java.lang.String getTopLevelToolkitName()
topLevelToolkitName
property.getTopLevelToolkitName
in interface ProcessTemplateData
ProcessTemplateData.getTopLevelToolkitName()
public java.lang.String getTopLevelToolkitAcronym()
topLevelToolkitAcronym
property.getTopLevelToolkitAcronym
in interface ProcessTemplateData
ProcessTemplateData.getTopLevelToolkitAcronym()
public boolean isTip()
isTip
property.isTip
in interface ProcessTemplateData
ProcessTemplateData.isTip()
public java.util.Calendar getValidFromTime()
validFromTime
.getValidFromTime
in interface ProcessTemplateData
ProcessTemplateData.getValidFromTime()
public java.lang.String getVersion()
version
.getVersion
in interface ProcessTemplateData
ProcessTemplateData.getVersion()
public TKTID getAdminTaskTemplateID()
adminTaskTemplateID
.getAdminTaskTemplateID
in interface ProcessTemplateData
ProcessTemplateData.getAdminTaskTemplateID()
public boolean isBusinessRelevant()
businessRelevant
property.isBusinessRelevant
in interface ProcessTemplateData
ProcessTemplateData.isBusinessRelevant()
public boolean isCompensationDefined()
compensationDefined
property.isCompensationDefined
in interface ProcessTemplateData
ProcessTemplateData.isCompensationDefined()
public boolean isContinueOnError()
continueOnError
property.isContinueOnError
in interface ProcessTemplateData
ProcessTemplateData.isContinueOnError()
public java.lang.String getCustomText1()
customText1
.getCustomText1
in interface ProcessTemplateData
ProcessTemplateData.getCustomText1()
public java.lang.String getCustomText2()
customText2
.getCustomText2
in interface ProcessTemplateData
ProcessTemplateData.getCustomText2()
public java.lang.String getCustomText3()
customText3
.getCustomText3
in interface ProcessTemplateData
ProcessTemplateData.getCustomText3()
public java.lang.String getCustomText4()
customText4
.getCustomText4
in interface ProcessTemplateData
ProcessTemplateData.getCustomText4()
public java.lang.String getCustomText5()
customText5
.getCustomText5
in interface ProcessTemplateData
ProcessTemplateData.getCustomText5()
public java.lang.String getCustomText6()
customText6
.getCustomText6
in interface ProcessTemplateData
ProcessTemplateData.getCustomText6()
public java.lang.String getCustomText7()
customText7
.getCustomText7
in interface ProcessTemplateData
ProcessTemplateData.getCustomText7()
public java.lang.String getCustomText8()
customText8
.getCustomText8
in interface ProcessTemplateData
ProcessTemplateData.getCustomText8()
public java.util.List getActivityServiceTemplates() throws ClientException
ActivityServiceTemplateBean
objects.ClientException