com.ibm.bpe.api

Interface ProcessTemplateData

All Superinterfaces:
java.io.Serializable
All known implementing classes:
ProcessTemplateBean

  1. public interface ProcessTemplateData
  2. extends java.io.Serializable
Accesses the properties of a process template.

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.

Since:
7.5 - introduced in 5.0

Field Summary

Modifier and Type Field and Description
  1. static
  2. int
AUTO_DELETE_NO
States that the process instance is not deleted when it reaches an end execution state.
  1. static
  2. int
AUTO_DELETE_ON_SUCCESSFUL_COMPLETION
States that the process instance is only deleted when it reaches the FINISHED state.
  1. static
  2. int
AUTO_DELETE_YES
States that the process instance is deleted when it reaches any execution end state.
  1. static
  2. int
AUTONOMY_CHILD
States that the process runs dependent of a potential parent process.
  1. static
  2. int
AUTONOMY_NOT_APPLICABLE
States that the process is a microflow where the autonomy flag is not applicable.
  1. static
  2. int
AUTONOMY_PEER
States that the process runs independently of a potential parent process.
  1. static
  2. java.lang.String
COPYRIGHT
  1. static
  2. int
EXECUTION_MODE_LONG_RUNNING
States that the process is a macroflow.
  1. static
  2. int
EXECUTION_MODE_MICROFLOW
States that the process is a microflow.
  1. static
  2. int
KIND_BLOCK
States that the process template describes a block construct.
  1. static
  2. int
KIND_PROCESS
States that the process template describes a business process.
  1. static
  2. int
SCHEMA_5_1
Do not use - internal only.
  1. static
  2. int
SCHEMA_5_1_1
Do not use - internal only.
  1. static
  2. int
SCHEMA_6_0
Do not use - internal only.
  1. static
  2. int
SCHEMA_6_0_2
Do not use - internal only.
  1. static
  2. int
SCHEMA_6_1
Do not use - internal only.
  1. static
  2. int
SCHEMA_6_1_2
Do not use - internal only.
  1. static
  2. int
SCHEMA_6_2
Do not use - internal only.
  1. static
  2. int
SCHEMA_7_0
Do not use - internal only.
  1. static
  2. int
SCHEMA_7_5_0
Do not use - internal only.
  1. static
  2. int
SCHEMA_7_5_1
Do not use - internal only.
  1. static
  2. int
STATE_MARKED_FOR_DELETION
States that the process template belongs to an application that is uninstalled but still referenced by existing activity instances.
  1. static
  2. int
STATE_STARTED
States that the process template is available for process instance creation.
  1. static
  2. int
STATE_STOPPED
States that the process template has been stopped.

Method Summary

Modifier and Type Method and Description
  1. TKTID
getAdminTaskTemplateID()
Returns the ID of the associated administration task template.
  1. java.lang.String
getApplicationName()
Returns the name of the application the process template is part of.
  1. boolean
getAutoDelete()
Deprecated. As of version 6.1, replaced by getAutoDeletionMode.
  1. int
getAutoDeletionMode()
Returns whether an instance of the process template is automatically or conditionally deleted when it reaches an end execution state.
  1. int
getAutonomy()
States whether an instance of the process template runs dependently of a potential parent or not.
  1. int[]
getAvailableActions()
Returns the actions that can be called for the current process template.
  1. java.util.Calendar
getCreationTime()
Returns the creation time of the process template.
  1. java.lang.String
getCustomText1()
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_1.
  1. java.lang.String
getCustomText2()
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_2.
  1. java.lang.String
getCustomText3()
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_3.
  1. java.lang.String
getCustomText4()
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_4.
  1. java.lang.String
getCustomText5()
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_5.
  1. java.lang.String
getCustomText6()
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_6.
  1. java.lang.String
getCustomText7()
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_7.
  1. java.lang.String
getCustomText8()
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_8.
  1. java.lang.String
getDescription()
Returns the description of the process template.
  1. java.lang.String
getDisplayName()
Returns the display name of the process template.
  1. java.lang.String
getDocumentation()
Returns the documentation of the process template.
  1. int
getExecutionMode()
States whether the process template can be executed as a microflow or as a macroflow.
  1. PTID
getID()
Returns the object identifier.
  1. java.lang.String
getInputMessageTypeName()
Returns the name of the input message type.
  1. java.lang.String
getInputMessageTypeTypeSystemName()
Deprecated. As of version 6.0, no replacement.
  1. java.util.Calendar
getLastModificationTime()
Returns the last time a property of the process template changed.
  1. java.lang.String
getName()
Returns the name of the process template.
  1. java.lang.String
getOutputMessageTypeName()
Returns the name of the output message type.
  1. java.lang.String
getOutputMessageTypeTypeSystemName()
Deprecated. As of version 6.0, no replacement.
  1. StaffResultSet
getProcessAdministrators()
Deprecated. As of version 6.0.2, replaced by HumanTaskManager.getUsersInRole(getAdminTaskTemplateID(), WorkItem.REASON_ADMINISTRATOR).
  1. java.lang.String
getProcessAppAcronym()
Returns an acronym for the process application.
  1. java.lang.String
getProcessAppName()
Returns the name of the process application that contains the process template.
  1. int
getSchemaVersion()
Returns the version of the XML schema that describes the process template.
  1. java.lang.String
getSnapshotID()
Returns the unique identifier of a snapshot that contains the process template.
  1. java.lang.String
getSnapshotName()
Returns the name of a snapshot that contains the process template.
  1. int
getState()
Returns the state of the process template.
  1. java.lang.String
getTargetNamespace()
Returns the target namespace of the process template.
  1. java.lang.String
getToolkitAcronym()
Returns the acronym of a toolkit that contains the process template.
  1. java.lang.String
getToolkitName()
Returns the name of a toolkit that contains the process template.
  1. java.lang.String
getToolkitSnapshotID()
Returns the unique ID of a toolkit snapshot that contains the process template.
  1. java.lang.String
getToolkitSnapshotName()
Returns the name of a toolkit snapshot that contains the process template.
  1. java.lang.String
getTopLevelToolkitAcronym()
Returns the acronym of the topmost toolkit that contains the process template.
  1. java.lang.String
getTopLevelToolkitName()
Returns the name of the topmost toolkit that contains the process template.
  1. java.lang.String
getTrackName()
Returns the name of the track that contains the process template.
  1. java.util.Calendar
getValidFromTime()
Returns the time the process template became or becomes valid.
  1. java.lang.String
getVersion()
Deprecated. As of version 7.5, no replacement.
  1. boolean
isBusinessRelevant()
States whether a process instance derived from this template is a business relevant or an "auxiliary" step.
  1. boolean
isCompensationDefined()
For a BPEL process, states whether an instance of the process template can be compensated.
  1. boolean
isContinueOnError()
States whether process instances derived from this template stop in case of an unhandled error or not.
  1. boolean
isTip()
States whether the process template is contained in a snapshot or whether it is more current.

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

STATE_STARTED

  1. static final int STATE_STARTED
States that the process template is available for process instance creation.
See Also:

STATE_MARKED_FOR_DELETION

  1. static final int STATE_MARKED_FOR_DELETION
States that the process template belongs to an application that is uninstalled but still referenced by existing activity instances.
See Also:

STATE_STOPPED

  1. static final int STATE_STOPPED
States that the process template has been stopped. Process instances cannot be created from the process template.
See Also:

SCHEMA_7_5_0

  1. static final int SCHEMA_7_5_0
Do not use - internal only.
See Also:

SCHEMA_7_5_1

  1. static final int SCHEMA_7_5_1
Do not use - internal only.
See Also:

SCHEMA_6_0

  1. static final int SCHEMA_6_0
Do not use - internal only.
See Also:

SCHEMA_5_1

  1. static final int SCHEMA_5_1
Do not use - internal only.
See Also:

SCHEMA_7_0

  1. static final int SCHEMA_7_0
Do not use - internal only.
See Also:

SCHEMA_6_1

  1. static final int SCHEMA_6_1
Do not use - internal only.
See Also:

SCHEMA_6_2

  1. static final int SCHEMA_6_2
Do not use - internal only.
See Also:

SCHEMA_5_1_1

  1. static final int SCHEMA_5_1_1
Do not use - internal only.
See Also:

SCHEMA_6_0_2

  1. static final int SCHEMA_6_0_2
Do not use - internal only.
See Also:

SCHEMA_6_1_2

  1. static final int SCHEMA_6_1_2
Do not use - internal only.
See Also:

EXECUTION_MODE_LONG_RUNNING

  1. static final int EXECUTION_MODE_LONG_RUNNING
States that the process is a macroflow.
See Also:

EXECUTION_MODE_MICROFLOW

  1. static final int EXECUTION_MODE_MICROFLOW
States that the process is a microflow.
See Also:

AUTONOMY_PEER

  1. static final int AUTONOMY_PEER
States that the process runs independently of a potential parent process.
See Also:

AUTONOMY_CHILD

  1. static final int AUTONOMY_CHILD
States that the process runs dependent of a potential parent process.
See Also:

AUTONOMY_NOT_APPLICABLE

  1. static final int AUTONOMY_NOT_APPLICABLE
States that the process is a microflow where the autonomy flag is not applicable.
See Also:

AUTO_DELETE_YES

  1. static final int AUTO_DELETE_YES
States that the process instance is deleted when it reaches any execution end state.
See Also:

AUTO_DELETE_ON_SUCCESSFUL_COMPLETION

  1. static final int AUTO_DELETE_ON_SUCCESSFUL_COMPLETION
States that the process instance is only deleted when it reaches the FINISHED state.
See Also:

AUTO_DELETE_NO

  1. static final int AUTO_DELETE_NO
States that the process instance is not deleted when it reaches an end execution state.
See Also:

KIND_BLOCK

  1. static final int KIND_BLOCK
States that the process template describes a block construct.
See Also:

KIND_PROCESS

  1. static final int KIND_PROCESS
States that the process template describes a business process.
See Also:

Method Detail

getID

  1. PTID getID()
Returns the object identifier.

getAutoDelete

  1. boolean getAutoDelete()
Deprecated. As of version 6.1, replaced by getAutoDeletionMode.
Returns whether an instance of the process template is deleted when it reaches an end execution state. While being deprecated, this method returns true for processes that specify 'yes' or 'onSuccessfulCompletion' for the autoDelete attribute.

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

  1. int[] getAvailableActions()
Returns the actions that can be called for the current process template. Refer to ProcessTemplateActions for the set of possible actions.

getCreationTime

  1. java.util.Calendar getCreationTime( )
Returns the creation time of the process template.

getDescription

  1. java.lang.String getDescription( )
Returns the description of the process template. If there is no description, null is returned.

getDocumentation

  1. java.lang.String getDocumentation( )
Returns the documentation of the process template. If there is no documentation, a null string is returned.

getState

  1. int getState()
Returns the state of the process template.

Returns whether the process template is started, stopped, or marked for deletion.


getSchemaVersion

  1. int getSchemaVersion()
Returns the version of the XML schema that describes the process template.

getLastModificationTime

  1. java.util.Calendar getLastModificationTime( )
Returns the last time a property of the process template changed.

getName

  1. java.lang.String getName()
Returns the name of the process template.

getApplicationName

  1. java.lang.String getApplicationName( )
Returns the name of the application the process template is part of.

getDisplayName

  1. java.lang.String getDisplayName( )
Returns the display name of the process template. If there is no display name, null is returned.

getValidFromTime

  1. java.util.Calendar getValidFromTime( )
Returns the time the process template became or becomes valid.

getVersion

  1. java.lang.String getVersion()
Deprecated. As of version 7.5, no replacement.
Returns a user-specified version of the process template. If there is no user-defined version, a null string is returned.

getExecutionMode

  1. int getExecutionMode()
States whether the process template can be executed as a microflow or as a macroflow.

Returns either EXECUTION_MODE_MICROFLOW or EXECUTION_MODE_LONG_RUNNING.


getAutonomy

  1. int getAutonomy()
States whether an instance of the process template runs dependently of a potential parent or not.

Returns either AUTONOMY_PEER or AUTONOMY_CHILD.


isCompensationDefined

  1. boolean isCompensationDefined()
For a BPEL process, states whether an instance of the process template can be compensated.

getInputMessageTypeName

  1. java.lang.String getInputMessageTypeName( )
Returns the name of the input message type. A BPEL process returns a value when there is only a single receive or a single pick with a single on-message that creates the process instance.

getInputMessageTypeTypeSystemName

  1. java.lang.String getInputMessageTypeTypeSystemName( )
Deprecated. As of version 6.0, no replacement.
Returns the name of the type system of the input message. A BPEL process returns a value when there is only a single receive or a single pick with a single on-message that creates the process instance.

getOutputMessageTypeName

  1. java.lang.String getOutputMessageTypeName( )
Returns the name of the output message type. A BPEL process returns a value when there is only a single receive or a single pick with a single on-message that creates the process instance.

getOutputMessageTypeTypeSystemName

  1. java.lang.String getOutputMessageTypeTypeSystemName( )
Deprecated. As of version 6.0, no replacement.
Returns the name of the type system of the output message. A BPEL process returns a value when there is only a single receive or a single pick with a single on-message that creates the process instance.

getProcessAdministrators

  1. StaffResultSet getProcessAdministrators( )
  2. throws WorkItemManagerException
  3. InvalidLengthException
Deprecated. As of version 6.0.2, replaced by HumanTaskManager.getUsersInRole(getAdminTaskTemplateID(), WorkItem.REASON_ADMINISTRATOR).
Returns the process administrators defined for instances of the process template.
Throws:

getTargetNamespace

  1. java.lang.String getTargetNamespace( )
Returns the target namespace of the process template.

isBusinessRelevant

  1. boolean isBusinessRelevant()
States whether a process instance derived from this template is a business relevant or an "auxiliary" step. A business relevant step can, for example, be logged into the audit trail.

getAdminTaskTemplateID

  1. TKTID getAdminTaskTemplateID()
Returns the ID of the associated administration task template.

isContinueOnError

  1. boolean isContinueOnError()
States whether process instances derived from this template stop in case of an unhandled error or not. True states that process instances continue navigation in case of an unhandled error. False states that process instances stop navigation in case of an unhandled error to allow for process repair.
Since:
6.1.2.

getSnapshotID

  1. java.lang.String getSnapshotID( )
Returns the unique identifier of a snapshot that contains the process template. Returns null if the template is not deployed as part of an application of the Process Server configured for the business process definition engine.
Since:
7.5.

getSnapshotName

  1. java.lang.String getSnapshotName( )
Returns the name of a snapshot that contains the process template. Returns null if the template is not deployed as part of an application of the Process Server configured for the business process definition engine.
Since:
7.5.

getTrackName

  1. java.lang.String getTrackName()
Returns the name of the track that contains the process template. Returns null if the template is not deployed as part of an application of the Process Server configured for the business process definition engine.
Since:
7.5.

getProcessAppName

  1. java.lang.String getProcessAppName( )
Returns the name of the process application that contains the process template. Returns null if the template is not deployed as part of an application of the Process Server configured for the business process definition engine.
Since:
7.5.

getProcessAppAcronym

  1. java.lang.String getProcessAppAcronym( )
Returns an acronym for the process application. Returns null if the template is not deployed as part of an application of the Process Server configured for the business process definition engine.
Since:
7.5.

getToolkitSnapshotID

  1. java.lang.String getToolkitSnapshotID( )
Returns the unique ID of a toolkit snapshot that contains the process template. Returns null if the template is not contained in a toolkit or not deployed as part of an application of the Process Server configured for the business process definition engine.
Since:
7.5.

getToolkitSnapshotName

  1. java.lang.String getToolkitSnapshotName( )
Returns the name of a toolkit snapshot that contains the process template. Returns null if the template is not contained in a toolkit or not deployed as part of an application of the Process Server configured for the business process definition engine.
Since:
7.5.

getToolkitName

  1. java.lang.String getToolkitName( )
Returns the name of a toolkit that contains the process template. Returns null if the template is not contained in a toolkit or not deployed as part of an application of the Process Server configured for the business process definition engine.
Since:
7.5.

getToolkitAcronym

  1. java.lang.String getToolkitAcronym( )
Returns the acronym of a toolkit that contains the process template. Returns null if the template is not contained in a toolkit or not deployed as part of an application of the Process Server configured for the business process definition engine.
Since:
7.5.

getTopLevelToolkitName

  1. java.lang.String getTopLevelToolkitName( )
Returns the name of the topmost toolkit that contains the process template. Returns null if the template is not contained in a toolkit or not deployed as part of an application of the Process Server configured for the business process definition engine.
Since:
7.5.

getTopLevelToolkitAcronym

  1. java.lang.String getTopLevelToolkitAcronym( )
Returns the acronym of the topmost toolkit that contains the process template. Returns null if the template is not contained in a toolkit or not deployed as part of an application of the Process Server configured for the business process definition engine.
Since:
7.5.

isTip

  1. boolean isTip()
States whether the process template is contained in a snapshot or whether it is more current. True states that the process template is a tip and not contained in a snapshot. False states that the process template is contained in a snapshot - see 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.
Since:
7.5.

getAutoDeletionMode

  1. int getAutoDeletionMode()
Returns whether an instance of the process template is automatically or conditionally deleted when it reaches an end execution state. Refer to 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.

Since:
6.1.

getCustomText1

  1. java.lang.String getCustomText1( )
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_1.
Since:
7.5.1.

getCustomText2

  1. java.lang.String getCustomText2( )
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_2.
Since:
7.5.1.

getCustomText3

  1. java.lang.String getCustomText3( )
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_3.
Since:
7.5.1.

getCustomText4

  1. java.lang.String getCustomText4( )
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_4.
Since:
7.5.1.

getCustomText5

  1. java.lang.String getCustomText5( )
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_5.
Since:
7.5.1.

getCustomText6

  1. java.lang.String getCustomText6( )
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_6.
Since:
7.5.1.

getCustomText7

  1. java.lang.String getCustomText7( )
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_7.
Since:
7.5.1.

getCustomText8

  1. java.lang.String getCustomText8( )
Returns the value of the inline custom property named InlineCustomProperty.CUSTOM_TEXT_8.
Since:
7.5.1.