|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProcessInstanceData
Accesses the properties of a process instance.
A process instance comes into existence when a process template is instantiated, for example, by an initiate or sendMessage 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)process compensation is failed. |
static int |
STATE_DELETED
States that the process has been deleted. |
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
Do not use - internal only. |
static int |
STATE_RUNNING
States that the process instance is running. |
static int |
STATE_SUSPENDED
States that the (sub)process instance is suspended. |
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 | |
---|---|
TKIID |
getAdminTaskID()
Returns the ID of the associated administration 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 associated process template. |
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. As of version 6.0, no replacement. |
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. As of version 6.0, no replacement. |
AIID |
getParentActivityInstanceID()
Returns the object ID of the parent activity instance, if any. |
PIID |
getParentProcessInstanceID()
Returns the object ID of the parent process instance, if any. |
java.lang.String |
getParentProcessInstanceName()
Returns the name of the parent process instance, if any. |
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.util.Calendar |
getResumptionTime()
Returns the resumption time of the process instance if the process instance is suspended and is to be resumed automatically. |
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 a hierarchy of processes. |
java.lang.String |
getTopLevelProcessInstanceName()
Returns the name of the topmost process instance in a hierarchy of processes. |
ProcessException |
getUnhandledException()
Returns the reason why the process instance failed. |
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. |
boolean |
isContinueOnError()
States whether the process instance stops in case of an unhandled error or not. |
boolean |
isMigrated()
States whether the process instance has been migrated. |
Field Detail |
---|
static final java.lang.String COPYRIGHT
static final int STATE_FINISHED
static final int STATE_COMPENSATING
static final int STATE_INDOUBT
static final int STATE_DELETED
static final int STATE_FAILED
static final int STATE_SUSPENDED
static final int STATE_TERMINATING
static final int STATE_RUNNING
static final int STATE_TERMINATED
static final int STATE_COMPENSATION_FAILED
static final int STATE_READY
static final int STATE_FAILING
static final int STATE_COMPENSATED
Method Detail |
---|
PIID getID()
java.util.Calendar getCompletionTime()
java.util.Calendar getCreationTime()
java.lang.String getProcessTemplateName()
PTID getProcessTemplateID()
java.util.Calendar getLastModificationTime()
java.util.Calendar getLastStateChangeTime()
java.lang.String getName()
java.lang.String getCompensationSphereName()
java.lang.String getDisplayName()
java.lang.String getDescription()
java.util.Calendar getStartTime()
int getExecutionState()
PIID getTopLevelProcessInstanceID()
java.lang.String getTopLevelProcessInstanceName()
PIID getParentProcessInstanceID()
java.lang.String getParentProcessInstanceName()
AIID getParentActivityInstanceID()
java.lang.String getStarter()
boolean isCompensationDefined()
java.lang.String getInputMessageTypeName()
java.lang.String getInputMessageTypeTypeSystemName()
java.lang.String getOutputMessageTypeName()
java.lang.String getOutputMessageTypeTypeSystemName()
java.lang.String getFaultName()
int[] getAvailableActions()
ProcessInstanceActions
for the set
of possible actions.
java.lang.String getCustomProperty(java.lang.String arg0)
arg0
- The name of the custom property for which the value is to be read.java.util.List getNamesOfCustomProperties()
StaffResultSet getProcessAdministrators() throws WorkItemManagerException, InvalidLengthException
WorkItemManagerException
InvalidLengthException
java.util.Calendar getValidFromTime()
TKIID getAdminTaskID()
boolean isBusinessRelevant()
boolean isContinueOnError()
java.util.Calendar getResumptionTime()
ProcessException getUnhandledException()
boolean isMigrated()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |