com.ibm.bpe.api
Interface ProcessTemplateData

All Superinterfaces:
java.io.Serializable

public interface ProcessTemplateData
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 business process. It can be instantiated and started by issuing appropriate requests, for example, initiate(). The execution of the process instance is driven automatically by the process engine.


Field Summary
static int AUTONOMY_CHILD
          States that the process runs dependent of a potential parent process.
static int AUTONOMY_NOT_APPLICABLE
          States that the process is a microflow where the autonomy flag is not applicable.
static int AUTONOMY_PEER
          States that the process runs independently of a potential parent process.
static int EXECUTION_MODE_LONG_RUNNING
          States that the process is a macroflow.
static int EXECUTION_MODE_MICROFLOW
          States that the process is a microflow.
static int KIND_BLOCK
          States that the process template describes a block construct.
static int KIND_PROCESS
          States that the process template describes a business process.
static int SCHEMA_1_0
          States that version 1.0 of the XML schema has been used to define the process template.
static int SCHEMA_1_1
          States that version 1.1 of the XML schema has been used to define the process template.
static int SCHEMA_5_1
          States that version 5.1 (BPEL) of the XML schema has been used to define the process template.
static int STATE_STARTED
          States that the process template is available for process instance creation.
static int STATE_STOPPED
          States that the process template has been stopped.
 
Method Summary
 java.lang.String getApplicationName()
          Returns the name of the application the process template is part of.
 boolean getAutoDelete()
          Returns whether an instance of the process template is automatically deleted when it reaches an end execution state.
 int getAutonomy()
          For a BPEL process, states whether an instance of the process template runs dependently of a potential parent or not.
 int[] getAvailableActions()
          Returns the actions that can be called for the current process template.
 boolean getCanRunInterrupted()
          Deprecated. The method name misleading for BPEL. Use getExecutionMode().
 boolean getCanRunSynchronously()
          Deprecated. Themethod name misleading for BPEL. Use getExecutionMode().
 java.lang.String getCategory()
          Deprecated.  
 java.util.Calendar getCreationTime()
          Returns the creation time of the process template.
 java.lang.String getDescription()
          Returns the description of the process template.
 java.lang.String getDisplayName()
          Returns the display name of the process template.
 java.lang.String getDocumentation()
          Returns the documentation of the process template.
 java.lang.String getEventMessageTypeName(java.lang.String arg0)
          Deprecated.  
 java.lang.String getEventMessageTypeTypeSystemName(java.lang.String arg0)
          Deprecated.  
 int getExecutionMode()
          For a BPEL process, states whether the process template can be executed as a microflow or as a macroflow.
 java.lang.String getFaultMessageTypeName(java.lang.String arg0)
          Deprecated.  
 java.lang.String getFaultMessageTypeTypeSystemName(java.lang.String arg0)
          Deprecated.  
 PTID getID()
          Returns the object identifier.
 java.lang.String getInputMessageTypeName()
          Returns the name of the input message type.
 java.lang.String getInputMessageTypeTypeSystemName()
          Returns the name of the type system of the input message.
 int getKind()
          Deprecated. A BPEL process always returns KIND_PROCESS.
 java.util.Calendar getLastModificationTime()
          Returns the last time a property of the process template changed.
 java.lang.String getName()
          Returns the name of the process template.
 java.lang.String getOutputMessageTypeName()
          Returns the name of the output message type.
 java.lang.String getOutputMessageTypeTypeSystemName()
          Returns the name of the type system of the output message.
 StaffResultSet getProcessAdministrators()
          Returns the process administrators defined for instances of the process template.
 int getSchemaVersion()
          Returns the version of the XML schema that describes the process template.
 int getState()
          States whether the process template is started or stopped.
 ClientObjectWrapper getUISettings(java.lang.String arg0)
          Deprecated. A BPEL process specifies custom client settings.
 java.util.Calendar getValidFromTime()
          Returns the time the process template became or becomes valid.
 java.lang.String getVariableTypeName(java.lang.String arg0)
          Deprecated.  
 java.lang.String getVariableTypeTypeSystemName(java.lang.String arg0)
          Deprecated.  
 java.lang.String getVersion()
          Returns a user-specified version of the process template.
 boolean isCompensationDefined()
          For a BPEL process, states whether an instance of the process template can be compensated.
 

Field Detail

STATE_STOPPED

public static final int STATE_STOPPED
States that the process template has been stopped. Process instances cannot be created from the process template.

See Also:
Constant Field Values

STATE_STARTED

public static final int STATE_STARTED
States that the process template is available for process instance creation.

See Also:
Constant Field Values

SCHEMA_1_0

public static final int SCHEMA_1_0
States that version 1.0 of the XML schema has been used to define the process template.

See Also:
Constant Field Values

SCHEMA_5_1

public static final int SCHEMA_5_1
States that version 5.1 (BPEL) of the XML schema has been used to define the process template.

See Also:
Constant Field Values

SCHEMA_1_1

public static final int SCHEMA_1_1
States that version 1.1 of the XML schema has been used to define the process template.

See Also:
Constant Field Values

EXECUTION_MODE_LONG_RUNNING

public static final int EXECUTION_MODE_LONG_RUNNING
States that the process is a macroflow.

See Also:
Constant Field Values

EXECUTION_MODE_MICROFLOW

public static final int EXECUTION_MODE_MICROFLOW
States that the process is a microflow.

See Also:
Constant Field Values

AUTONOMY_PEER

public static final int AUTONOMY_PEER
States that the process runs independently of a potential parent process.

See Also:
Constant Field Values

AUTONOMY_NOT_APPLICABLE

public static final int AUTONOMY_NOT_APPLICABLE
States that the process is a microflow where the autonomy flag is not applicable.

See Also:
Constant Field Values

AUTONOMY_CHILD

public static final int AUTONOMY_CHILD
States that the process runs dependent of a potential parent process.

See Also:
Constant Field Values

KIND_BLOCK

public static final int KIND_BLOCK
States that the process template describes a block construct.

See Also:
Constant Field Values

KIND_PROCESS

public static final int KIND_PROCESS
States that the process template describes a business process.

See Also:
Constant Field Values
Method Detail

getID

public PTID getID()
Returns the object identifier.


getCanRunInterrupted

public boolean getCanRunInterrupted()
Deprecated. The method name misleading for BPEL. Use getExecutionMode().

Returns whether an instance of the process template can run interrupted, that is, whether you can use initiate() to start execution. A BPEL process can be started using initiate() when there is only a single receive or a single pick with a single on-message that creates the process instance.

Processes started by initiate() run as a series of transactions. They are normally long-running processes involving staff or JMS-based activity invocations.


getCanRunSynchronously

public boolean getCanRunSynchronously()
Deprecated. Themethod name misleading for BPEL. Use getExecutionMode().

Returns whether an instance of the process template can run synchronously, that is, whether you can use call() to start execution. A BPEL process can be started using call() when the process instance is a microflow and there is only a single receive or a single pick with a single on-message that creates the process instance.

Processes started by call() run in a single transaction and return only, when a result is produced. They are normally short-running, fully-automatic processes that synchronously invoke activities.


getAutoDelete

public boolean getAutoDelete()
Returns whether an instance of the process template is automatically deleted when it reaches an end execution state.

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

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


getCreationTime

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


getDescription

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


getDocumentation

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


getKind

public int getKind()
Deprecated. A BPEL process always returns KIND_PROCESS.

States whether the process template describes a business process or a block.

Returns either KIND_BLOCK or KIND_PROCESS.


getState

public int getState()
States whether the process template is started or stopped.

Returns either STATE_STARTED or STATE_STOPPED.


getSchemaVersion

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


getLastModificationTime

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


getName

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


getApplicationName

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


getDisplayName

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


getCategory

public java.lang.String getCategory()
Deprecated.  

Returns the category of the process template. If there is no category, a null string is returned.


getValidFromTime

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


getVersion

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


getExecutionMode

public int getExecutionMode()
For a BPEL process, 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

public int getAutonomy()
For a BPEL process, states whether an instance of the process template runs dependently of a potential parent or not.

Returns either AUTONOMY_PEER or AUTONOMY_CHILD.


isCompensationDefined

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


getInputMessageTypeName

public 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

public java.lang.String getInputMessageTypeTypeSystemName()
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.


getEventMessageTypeName

public java.lang.String getEventMessageTypeName(java.lang.String arg0)
Deprecated.  

Returns the name of the specified event message type. Returns null for a BPEL process.


getEventMessageTypeTypeSystemName

public java.lang.String getEventMessageTypeTypeSystemName(java.lang.String arg0)
Deprecated.  

Returns the name of the type system of the specified event message. Returns null for a BPEL process.


getOutputMessageTypeName

public 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

public java.lang.String getOutputMessageTypeTypeSystemName()
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.


getFaultMessageTypeName

public java.lang.String getFaultMessageTypeName(java.lang.String arg0)
Deprecated.  

Returns the name of the specified fault message type. Returns a null string when the specified fault is not found. A BPEL process returns null.


getFaultMessageTypeTypeSystemName

public java.lang.String getFaultMessageTypeTypeSystemName(java.lang.String arg0)
Deprecated.  

Returns the name of the type system of the specified fault message. Returns a null string when the specified fault is not found. A BPEL process returns null.


getVariableTypeName

public java.lang.String getVariableTypeName(java.lang.String arg0)
Deprecated.  

Returns the type name of the specified variable. Returns a null string when the specified variable is not associated to the process template. A BPEL process returns null.


getVariableTypeTypeSystemName

public java.lang.String getVariableTypeTypeSystemName(java.lang.String arg0)
Deprecated.  

Returns the name of the type system of the specified variable type. Returns a null string when the specified variable is not associated to the process template. A BPEL process returns null.


getUISettings

public ClientObjectWrapper getUISettings(java.lang.String arg0)
                                  throws IdWrongTypeException
Deprecated. A BPEL process specifies custom client settings.

Returns the value of the specified user interface setting. Returns a null object when the specified user interface setting is not found. A BPEL process returns null.

Throws:
IdWrongTypeException

getProcessAdministrators

public StaffResultSet getProcessAdministrators()
                                        throws WorkItemManagerException,
                                               InvalidLengthException
Returns the process administrators defined for instances of the process template.

Throws:
WorkItemManagerException
InvalidLengthException