|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ProcessInstance
The ProcessInstance represents a snapshot of the execution state of an
process instance.
The corresponding runtime object is stored in the process_instance
table of the audit trail database.
| Field Summary | |
|---|---|
static long |
UNKNOWN_OID
This will be returned if the OID is not known. |
| Fields inherited from interface org.eclipse.stardust.engine.api.runtime.IDescriptorProvider |
|---|
PRP_DESCRIPTOR_IDS, PRP_PROPVIDE_DESCRIPTORS |
| Method Summary | |
|---|---|
ProcessInstanceAttributes |
getAttributes()
Retrieves extended attributes. |
long |
getBenchmark()
|
org.eclipse.stardust.engine.core.benchmark.BenchmarkResult |
getBenchmarkResult()
|
String |
getBusinessCalendarId()
Gets the identifier of the Business Calendar associated with this process instance. |
ProcessInstanceDetailsLevel |
getDetailsLevel()
Retrieves the level of details for process instance. |
EnumSet<ProcessInstanceDetailsOptions> |
getDetailsOptions()
Retrieves the options used for details creation for process instance. |
List<HistoricalEvent> |
getHistoricalEvents()
Gets a list of requested additional data like notes, delegations, state changes and exceptions. |
List<org.eclipse.stardust.engine.api.runtime.ProcessInstanceLink> |
getLinkedProcessInstances()
Returns process instance links which have this process instance as source or target. |
long |
getParentProcessInstanceOid()
Gets the oid of the parent process instance. |
PermissionState |
getPermission(String permissionId)
Returns the permission state of the given permission id for the current user. |
int |
getPriority()
Gets the priority of the process instance. |
String |
getProcessID()
Gets ID of this process instance's definition. |
String |
getProcessName()
Gets name of this process instance's definition. |
String |
getRootProcessInstanceName()
Gets the name of the ultimate root process instance. |
long |
getRootProcessInstanceOID()
Gets the OID of the ultimate root process instance. |
Map<String,Object> |
getRuntimeAttributes()
|
ProcessInstance |
getScopeProcessInstance()
Gets the the scope process instance the data values of this process instance are bound to. |
long |
getScopeProcessInstanceOID()
Gets the OID of the scope process instance the data values of this process instance are bound to. |
User |
getStartingUser()
Gets the User object of the user that have started the process instance. |
Date |
getStartTime()
Gets the time when this process instance was created. |
ProcessInstanceState |
getState()
Gets the current state of the process instance. |
Date |
getTerminationTime()
Gets the time when this process instance was terminated. |
boolean |
isCaseProcessInstance()
Allows to check if the process instance is a case process instance which is used to group other process instances. |
| Methods inherited from interface org.eclipse.stardust.engine.api.runtime.RuntimeObject |
|---|
getModelElementID, getModelElementOID, getModelOID, getOID |
| Methods inherited from interface org.eclipse.stardust.engine.api.runtime.IDescriptorProvider |
|---|
getDescriptorDefinitions, getDescriptorValue |
| Field Detail |
|---|
static final long UNKNOWN_OID
| Method Detail |
|---|
String getProcessID()
RuntimeObject.getModelElementID().
String getProcessName()
getProcessName()long getRootProcessInstanceOID()
RuntimeObject.getOID() for
top-level processes.
String getRootProcessInstanceName()
getProcessName() for
top-level processes.
long getScopeProcessInstanceOID()
ProcessInstance getScopeProcessInstance()
int getPriority()
Date getStartTime()
Date getTerminationTime()
User getStartingUser()
User object of the user that have started the process instance.
User object of the user.ProcessInstanceState getState()
ProcessInstanceDetailsLevel getDetailsLevel()
EnumSet<ProcessInstanceDetailsOptions> getDetailsOptions()
ProcessInstanceAttributes getAttributes()
Map<String,Object> getRuntimeAttributes()
List<HistoricalEvent> getHistoricalEvents()
HistoricalEventPolicy applied to
ProcessInstanceQuery. By default this list will be empty as
retrieval might degrade query performance.
HistoricalEvent,
HistoricalEventPolicyPermissionState getPermission(String permissionId)
permissionId -
long getParentProcessInstanceOid()
ProcessInstanceDetailsOptions.WITH_HIERARCHY_INFO has been set at
ProcessInstanceDetailsPolicy.
UNKNOWN_OID will be
returned if an error occurred or details option has not been set.List<org.eclipse.stardust.engine.api.runtime.ProcessInstanceLink> getLinkedProcessInstances()
ProcessInstanceDetailsOptions.WITH_LINK_INFO has been set at
ProcessInstanceDetailsPolicy.
boolean isCaseProcessInstance()
WorkflowService.createCase(String, String, long[]),
WorkflowService.joinCase(long, long[]),
WorkflowService.leaveCase(long, long[]),
WorkflowService.mergeCases(long, long[], String)org.eclipse.stardust.engine.core.benchmark.BenchmarkResult getBenchmarkResult()
long getBenchmark()
String getBusinessCalendarId()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||