|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Accesses the properties of a process instance.
A process instance comes into existence when a process template is instantiated, for example, by an initiate request. It is started immediately causing its state initially to be set to running. Execution is driven automatically by the process engine.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT
|
static int |
STATE_COMPENSATED
States that compensation has been finished for the process instance. |
static int |
STATE_COMPENSATING
States that compensation has been started for the process instance. |
static int |
STATE_COMPENSATION_FAILED
States that the (sub)proces compensation is failed. |
static int |
STATE_FAILED
States that the process instance failed to execute. |
static int |
STATE_FAILING
States that an expected or unexpected exception has been encountered. |
static int |
STATE_FINISHED
States that the process instance completed successfully. |
static int |
STATE_INDOUBT
States that the compensation has encounterd a problem. |
static int |
STATE_READY
For future use. |
static int |
STATE_RUNNING
States that the process instance is running. |
static int |
STATE_SUSPENDED
States that the (sub)process instance is supspended |
static int |
STATE_TERMINATED
States that the process instance has been terminated because of an external or internal request. |
static int |
STATE_TERMINATING
States that the (sub)process instance is terminating because of an internal request. |
Method Summary | |
---|---|
com.ibm.task.api.TKIID |
getAdminTaskID()
Returns the ID of the associated administrative task. |
int[] |
getAvailableActions()
Returns the actions that can be called in the current process instance execution state. |
java.lang.String |
getCompensationSphereName()
Returns the name of the associated compensation sphere. |
java.util.Calendar |
getCompletionTime()
Returns the completion time of the process instance. |
java.util.Calendar |
getCreationTime()
Returns the creation time of the process instance. |
java.lang.String |
getCustomProperty(java.lang.String arg0)
Returns the value of the specified custom property. |
java.lang.String |
getDescription()
Returns the description of the process instance. |
java.lang.String |
getDisplayName()
Returns the display name of the process instance. |
int |
getExecutionState()
Returns the execution state of the process instance. |
java.lang.String |
getFaultName()
Returns the name of the fault if the process instance ended with a fault or EngineMissingReplyException if the process instance implements a two-way operation and did not navigate the corresponding reply activity. |
PIID |
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 instance changed. |
java.util.Calendar |
getLastStateChangeTime()
Returns the last time the execution state of the process instance changed. |
java.lang.String |
getName()
Returns the name of the process instance. |
java.util.List |
getNamesOfCustomProperties()
Returns the names of all custom properties. |
java.lang.String |
getOutputMessageTypeName()
Returns the name of the output message type. |
java.lang.String |
getOutputMessageTypeTypeSystemName()
Deprecated. |
StaffResultSet |
getProcessAdministrators()
Returns the process administrators. |
PTID |
getProcessTemplateID()
Returns the object ID of the process template this instance is derived from. |
java.lang.String |
getProcessTemplateName()
Returns the name of the process template this instance is derived from. |
java.lang.String |
getStarter()
Returns the starter of the process instance. |
java.util.Calendar |
getStartTime()
Returns the start time of the process instance. |
PIID |
getTopLevelProcessInstanceID()
Returns the object ID of the topmost process instance in the hierarchy. |
java.lang.String |
getTopLevelProcessInstanceName()
Returns the name of the topmost process instance in the hierarchy. |
java.util.Calendar |
getValidFromTime()
Returns the time the process template became or becomes valid. |
boolean |
isBusinessRelevant()
States whether the process instance is a business relevant or an "auxiliary" step. |
boolean |
isCompensationDefined()
States whether the process instance can be compensated. |
Field Detail |
public static final java.lang.String COPYRIGHT
public static final int STATE_TERMINATED
public static final int STATE_FAILED
public static final int STATE_READY
public static final int STATE_INDOUBT
public static final int STATE_RUNNING
public static final int STATE_FINISHED
public static final int STATE_COMPENSATION_FAILED
public static final int STATE_COMPENSATED
public static final int STATE_SUSPENDED
public static final int STATE_FAILING
public static final int STATE_COMPENSATING
public static final int STATE_TERMINATING
Method Detail |
public PIID getID()
public java.util.Calendar getCompletionTime()
public java.util.Calendar getCreationTime()
public java.lang.String getProcessTemplateName()
public PTID getProcessTemplateID()
public java.util.Calendar getLastModificationTime()
public java.util.Calendar getLastStateChangeTime()
public java.lang.String getName()
public java.lang.String getCompensationSphereName()
public java.lang.String getDisplayName()
public java.lang.String getDescription()
public java.util.Calendar getStartTime()
public int getExecutionState()
public PIID getTopLevelProcessInstanceID()
public java.lang.String getTopLevelProcessInstanceName()
public java.lang.String getStarter()
public boolean isCompensationDefined()
public java.lang.String getInputMessageTypeName()
public java.lang.String getInputMessageTypeTypeSystemName()
public java.lang.String getOutputMessageTypeName()
public java.lang.String getOutputMessageTypeTypeSystemName()
public java.lang.String getFaultName()
public int[] getAvailableActions()
ProcessInstanceActions
for the set
of possible actions.
public java.lang.String getCustomProperty(java.lang.String arg0)
arg0
- The name of the custom property for which the value is to be read.public java.util.List getNamesOfCustomProperties()
public StaffResultSet getProcessAdministrators() throws WorkItemManagerException, InvalidLengthException
WorkItemManagerException
InvalidLengthException
public java.util.Calendar getValidFromTime()
public com.ibm.task.api.TKIID getAdminTaskID()
public boolean isBusinessRelevant()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |