com.ibm.bpe.api
Interface ProcessTemplateData
- public interface ProcessTemplateData
- extends java.io.Serializable
A process template is a versioned, deployed, and installed process model that contains the specification of a process. It can be instantiated and started by issuing appropriate requests, for example, initiate or sendMessage. The execution of the process instance is driven automatically by the process engine.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
AUTO_DELETE_NO
States that the process instance is not deleted when it reaches an end execution state.
|
|
AUTO_DELETE_ON_SUCCESSFUL_COMPLETION
States that the process instance is only deleted when it reaches the FINISHED state.
|
|
AUTO_DELETE_YES
States that the process instance is deleted when it reaches any execution end state.
|
|
AUTONOMY_CHILD
States that the process runs dependent of a potential parent process.
|
|
AUTONOMY_NOT_APPLICABLE
States that the process is a microflow where the autonomy flag is not applicable.
|
|
AUTONOMY_PEER
States that the process runs independently of a potential parent process.
|
|
COPYRIGHT
|
|
EXECUTION_MODE_LONG_RUNNING
States that the process is a macroflow.
|
|
EXECUTION_MODE_MICROFLOW
States that the process is a microflow.
|
|
KIND_BLOCK
States that the process template describes a block construct.
|
|
KIND_PROCESS
States that the process template describes a business process.
|
|
SCHEMA_5_1
Do not use - internal only.
|
|
SCHEMA_5_1_1
Do not use - internal only.
|
|
SCHEMA_6_0
Do not use - internal only.
|
|
SCHEMA_6_0_2
Do not use - internal only.
|
|
SCHEMA_6_1
Do not use - internal only.
|
|
SCHEMA_6_1_2
Do not use - internal only.
|
|
SCHEMA_6_2
Do not use - internal only.
|
|
SCHEMA_7_0
Do not use - internal only.
|
|
SCHEMA_7_5_0
Do not use - internal only.
|
|
SCHEMA_7_5_1
Do not use - internal only.
|
|
STATE_MARKED_FOR_DELETION
States that the process template belongs to an application that
is uninstalled but still referenced by existing activity instances.
|
|
STATE_STARTED
States that the process template is available for process instance creation.
|
|
STATE_STOPPED
States that the process template has been stopped.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
getAdminTaskTemplateID()
Returns the ID of the associated administration task template.
|
|
|
getApplicationName()
Returns the name of the application the process template is part of.
|
|
getAutoDelete()
Deprecated. As of version 6.1, replaced by
getAutoDeletionMode .
|
|
getAutoDeletionMode()
Returns whether an instance of the process template is automatically or
conditionally deleted when it reaches an end execution state.
|
|
getAutonomy()
States whether an instance of the process template runs dependently of a potential parent or not.
|
|
getAvailableActions()
Returns the actions that can be called for the current process template.
|
|
getCreationTime()
Returns the creation time of the process template.
|
|
getCustomText1()
Returns the value of the inline custom property named
InlineCustomProperty.CUSTOM_TEXT_1 .
|
|
getCustomText2()
Returns the value of the inline custom property named
InlineCustomProperty.CUSTOM_TEXT_2 .
|
|
getCustomText3()
Returns the value of the inline custom property named
InlineCustomProperty.CUSTOM_TEXT_3 .
|
|
getCustomText4()
Returns the value of the inline custom property named
InlineCustomProperty.CUSTOM_TEXT_4 .
|
|
getCustomText5()
Returns the value of the inline custom property named
InlineCustomProperty.CUSTOM_TEXT_5 .
|
|
getCustomText6()
Returns the value of the inline custom property named
InlineCustomProperty.CUSTOM_TEXT_6 .
|
|
getCustomText7()
Returns the value of the inline custom property named
InlineCustomProperty.CUSTOM_TEXT_7 .
|
|
getCustomText8()
Returns the value of the inline custom property named
InlineCustomProperty.CUSTOM_TEXT_8 .
|
|
getDescription()
Returns the description of the process template.
|
|
getDisplayName()
Returns the display name of the process template.
|
|
getDocumentation()
Returns the documentation of the process template.
|
|
getExecutionMode()
States whether the process template can be executed as a microflow or as a macroflow.
|
getID()
Returns the object identifier.
|
|
|
getInputMessageTypeName()
Returns the name of the input message type.
|
|
getInputMessageTypeTypeSystemName()
Deprecated. As of version 6.0, no replacement.
|
|
getLastModificationTime()
Returns the last time a property of the process template changed.
|
|
getName()
Returns the name of the process template.
|
|
getOutputMessageTypeName()
Returns the name of the output message type.
|
|
getOutputMessageTypeTypeSystemName()
Deprecated. As of version 6.0, no replacement.
|
getProcessAdministrators()
Deprecated. As of version 6.0.2, replaced by HumanTaskManager.getUsersInRole(getAdminTaskTemplateID(), WorkItem.REASON_ADMINISTRATOR).
|
|
|
getProcessAppAcronym()
Returns an acronym for the process application.
|
|
getProcessAppName()
Returns the name of the process application that contains the process template.
|
|
getSchemaVersion()
Returns the version of the XML schema that describes the process template.
|
|
getSnapshotID()
Returns the unique identifier of a snapshot that contains the process template.
|
|
getSnapshotName()
Returns the name of a snapshot that contains the process template.
|
|
getState()
Returns the state of the process template.
|
|
getTargetNamespace()
Returns the target namespace of the process template.
|
|
getToolkitAcronym()
Returns the acronym of a toolkit that contains the process template.
|
|
getToolkitName()
Returns the name of a toolkit that contains the process template.
|
|
getToolkitSnapshotID()
Returns the unique ID of a toolkit snapshot that contains the process template.
|
|
getToolkitSnapshotName()
Returns the name of a toolkit snapshot that contains the process template.
|
|
getTopLevelToolkitAcronym()
Returns the acronym of the topmost toolkit that contains the process template.
|
|
getTopLevelToolkitName()
Returns the name of the topmost toolkit that contains the process template.
|
|
getTrackName()
Returns the name of the track that contains the process template.
|
|
getValidFromTime()
Returns the time the process template became or becomes valid.
|
|
getVersion()
Deprecated. As of version 7.5, no replacement.
|
|
isBusinessRelevant()
States whether a process instance derived from this template is a business relevant or an "auxiliary" step.
|
|
isCompensationDefined()
For a BPEL process, states whether an instance of the process template can be compensated.
|
|
isContinueOnError()
States whether process instances derived from this template
stop in case of an unhandled error or not.
|
|
isTip()
States whether the process template is contained in a snapshot or whether it is
more current.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
STATE_STARTED
- static final int STATE_STARTED
STATE_MARKED_FOR_DELETION
- static final int STATE_MARKED_FOR_DELETION
STATE_STOPPED
- static final int STATE_STOPPED
SCHEMA_7_5_0
- static final int SCHEMA_7_5_0
SCHEMA_7_5_1
- static final int SCHEMA_7_5_1
SCHEMA_6_0
- static final int SCHEMA_6_0
SCHEMA_5_1
- static final int SCHEMA_5_1
SCHEMA_7_0
- static final int SCHEMA_7_0
SCHEMA_6_1
- static final int SCHEMA_6_1
SCHEMA_6_2
- static final int SCHEMA_6_2
SCHEMA_5_1_1
- static final int SCHEMA_5_1_1
SCHEMA_6_0_2
- static final int SCHEMA_6_0_2
SCHEMA_6_1_2
- static final int SCHEMA_6_1_2
EXECUTION_MODE_LONG_RUNNING
- static final int EXECUTION_MODE_LONG_RUNNING
EXECUTION_MODE_MICROFLOW
- static final int EXECUTION_MODE_MICROFLOW
AUTONOMY_PEER
- static final int AUTONOMY_PEER
AUTONOMY_CHILD
- static final int AUTONOMY_CHILD
AUTONOMY_NOT_APPLICABLE
- static final int AUTONOMY_NOT_APPLICABLE
AUTO_DELETE_YES
- static final int AUTO_DELETE_YES
AUTO_DELETE_ON_SUCCESSFUL_COMPLETION
- static final int AUTO_DELETE_ON_SUCCESSFUL_COMPLETION
AUTO_DELETE_NO
- static final int AUTO_DELETE_NO
KIND_BLOCK
- static final int KIND_BLOCK
KIND_PROCESS
- static final int KIND_PROCESS
Method Detail
getID
- PTID getID()
getAutoDelete
- boolean getAutoDelete()
getAutoDeletionMode
.
End execution states are STATE_FINISHED, STATE_COMPENSATED, STATE_TERMINATED, or STATE_FAILED. STATE_FAILED is only an end execution state if no compensation is defined.
getAvailableActions
- int[] getAvailableActions()
ProcessTemplateActions
for the set
of possible actions.
getCreationTime
- java.util.Calendar getCreationTime( )
getDescription
- java.lang.String getDescription( )
getDocumentation
- java.lang.String getDocumentation( )
getState
- int getState()
Returns whether the process template is started, stopped, or marked for deletion.
getSchemaVersion
- int getSchemaVersion()
getLastModificationTime
- java.util.Calendar getLastModificationTime( )
getName
- java.lang.String getName()
getApplicationName
- java.lang.String getApplicationName( )
getDisplayName
- java.lang.String getDisplayName( )
getValidFromTime
- java.util.Calendar getValidFromTime( )
getVersion
- java.lang.String getVersion()
getExecutionMode
- int getExecutionMode()
Returns either EXECUTION_MODE_MICROFLOW or EXECUTION_MODE_LONG_RUNNING.
getAutonomy
- int getAutonomy()
Returns either AUTONOMY_PEER or AUTONOMY_CHILD.
isCompensationDefined
- boolean isCompensationDefined()
getInputMessageTypeName
- java.lang.String getInputMessageTypeName( )
getInputMessageTypeTypeSystemName
- java.lang.String getInputMessageTypeTypeSystemName( )
getOutputMessageTypeName
- java.lang.String getOutputMessageTypeName( )
getOutputMessageTypeTypeSystemName
- java.lang.String getOutputMessageTypeTypeSystemName( )
getProcessAdministrators
- StaffResultSet getProcessAdministrators( )
- throws WorkItemManagerException
- InvalidLengthException
getTargetNamespace
- java.lang.String getTargetNamespace( )
isBusinessRelevant
- boolean isBusinessRelevant()
getAdminTaskTemplateID
- TKTID getAdminTaskTemplateID()
isContinueOnError
- boolean isContinueOnError()
getSnapshotID
- java.lang.String getSnapshotID( )
getSnapshotName
- java.lang.String getSnapshotName( )
getTrackName
- java.lang.String getTrackName()
getProcessAppName
- java.lang.String getProcessAppName( )
getProcessAppAcronym
- java.lang.String getProcessAppAcronym( )
getToolkitSnapshotID
- java.lang.String getToolkitSnapshotID( )
getToolkitSnapshotName
- java.lang.String getToolkitSnapshotName( )
getToolkitName
- java.lang.String getToolkitName( )
getToolkitAcronym
- java.lang.String getToolkitAcronym( )
getTopLevelToolkitName
- java.lang.String getTopLevelToolkitName( )
getTopLevelToolkitAcronym
- java.lang.String getTopLevelToolkitAcronym( )
isTip
- boolean isTip()
getSnapshotName
- or
that the process template is not deployed as part of an application of the
Process Server configured for the business process definition engine.
getAutoDeletionMode
- int getAutoDeletionMode()
AutoDeletionMode
for the possible deletion modes.
End execution states are STATE_FINISHED, STATE_COMPENSATED, STATE_TERMINATED, or STATE_FAILED. STATE_FAILED is only an end execution state if no compensation is defined.
getCustomText1
- java.lang.String getCustomText1( )
InlineCustomProperty.CUSTOM_TEXT_1
.
getCustomText2
- java.lang.String getCustomText2( )
InlineCustomProperty.CUSTOM_TEXT_2
.
getCustomText3
- java.lang.String getCustomText3( )
InlineCustomProperty.CUSTOM_TEXT_3
.
getCustomText4
- java.lang.String getCustomText4( )
InlineCustomProperty.CUSTOM_TEXT_4
.
getCustomText5
- java.lang.String getCustomText5( )
InlineCustomProperty.CUSTOM_TEXT_5
.
getCustomText6
- java.lang.String getCustomText6( )
InlineCustomProperty.CUSTOM_TEXT_6
.
getCustomText7
- java.lang.String getCustomText7( )
InlineCustomProperty.CUSTOM_TEXT_7
.
getCustomText8
- java.lang.String getCustomText8( )
InlineCustomProperty.CUSTOM_TEXT_8
.