|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 java.lang.String |
COPYRIGHT
|
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_5_1
States the XML schema version of the BPEL file that has been used to define the process template. |
static int |
SCHEMA_5_1_1
For future use. |
static int |
SCHEMA_6_0
For future use. |
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()
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. |
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. |
int |
getExecutionMode()
States whether the process template can be executed as a microflow or as a macroflow. |
PTID |
getID()
Returns the object identifier. |
java.lang.String |
getInputMessageTypeName()
Returns the name of the input message type. |
java.lang.String |
getInputMessageTypeTypeSystemName()
Deprecated. |
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()
Deprecated. |
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. |
java.lang.String |
getTargetNamespace()
Returns the target namespace of the process template. |
java.util.Calendar |
getValidFromTime()
Returns the time the process template became or becomes valid. |
java.lang.String |
getVersion()
Returns a user-specified version of the process template. |
boolean |
isBusinessRelevant()
States whether a process instance derived from this template is a business relevant or an "auxiliary" step. |
boolean |
isCompensationDefined()
For a BPEL process, states whether an instance of the process template can be compensated. |
Field Detail |
public static final java.lang.String COPYRIGHT
public static final int STATE_STOPPED
public static final int STATE_STARTED
public static final int SCHEMA_6_0
public static final int SCHEMA_5_1
public static final int SCHEMA_5_1_1
public static final int EXECUTION_MODE_LONG_RUNNING
public static final int EXECUTION_MODE_MICROFLOW
public static final int AUTONOMY_PEER
public static final int AUTONOMY_NOT_APPLICABLE
public static final int AUTONOMY_CHILD
public static final int KIND_BLOCK
public static final int KIND_PROCESS
Method Detail |
public PTID getID()
public boolean getAutoDelete()
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.
public int[] getAvailableActions()
ProcessTemplateActions
for the set
of possible actions.
public java.util.Calendar getCreationTime()
public java.lang.String getDescription()
public java.lang.String getDocumentation()
public int getState()
Returns either STATE_STARTED or STATE_STOPPED.
public int getSchemaVersion()
public java.util.Calendar getLastModificationTime()
public java.lang.String getName()
public java.lang.String getApplicationName()
public java.lang.String getDisplayName()
public java.util.Calendar getValidFromTime()
public java.lang.String getVersion()
public int getExecutionMode()
Returns either EXECUTION_MODE_MICROFLOW or EXECUTION_MODE_LONG_RUNNING.
public int getAutonomy()
Returns either AUTONOMY_PEER or AUTONOMY_CHILD.
public boolean isCompensationDefined()
public java.lang.String getInputMessageTypeName()
public java.lang.String getInputMessageTypeTypeSystemName()
public java.lang.String getOutputMessageTypeName()
public java.lang.String getOutputMessageTypeTypeSystemName()
public StaffResultSet getProcessAdministrators() throws WorkItemManagerException, InvalidLengthException
WorkItemManagerException
InvalidLengthException
public java.lang.String getTargetNamespace()
public boolean isBusinessRelevant()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |