|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.stardust.engine.api.dto.RuntimeObjectDetails
org.eclipse.stardust.engine.api.dto.ProcessInstanceDetails
public class ProcessInstanceDetails
Many methods of the CARNOT EJBs return detail objects. Detail objects are serializable helper objects passed by value to the client. They can, for instance, pass the necessary information from the audit trail to the embedding application in a dynamic way to guarantee an optimum of performance. Instances of the class ProcessInstanceDetails are always referring to runtime objects - process instances - and contain data of these runtime objects (e.g. their OID, ID or start timestamp).
| Field Summary | |
|---|---|
static String |
PRP_PI_DETAILS_OPTIONS
|
| Fields inherited from interface org.eclipse.stardust.engine.api.runtime.ProcessInstance |
|---|
UNKNOWN_OID |
| 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. |
List<DataPath> |
getDescriptorDefinitions()
Retrieves definitions for available descriptors. |
Map<String,Object> |
getDescriptors()
|
Object |
getDescriptorValue(String id)
Gets the current value of a descriptor with the specified ID. |
ProcessInstanceDetailsLevel |
getDetailsLevel()
Retrieves the level of details for process instance. |
EnumSet<ProcessInstanceDetailsOptions> |
getDetailsOptions()
Retrieves the options used for details creation for process instance. |
List<org.eclipse.stardust.engine.api.dto.HistoricalData> |
getHistoricalData()
|
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. |
long |
getStartingActivityInstanceOID()
|
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. |
static void |
initDescriptors(org.eclipse.stardust.engine.core.runtime.beans.IProcessInstance processInstance,
List<DataPath> descriptorDefinitions,
Map<String,Object> descriptors)
|
static User |
initStartingUser(org.eclipse.stardust.engine.core.runtime.beans.IProcessInstance processInstance,
org.eclipse.stardust.common.config.Parameters parameters,
UserDetailsLevel userDetailsLevel)
|
boolean |
isCaseProcessInstance()
Allows to check if the process instance is a case process instance which is used to group other process instances. |
String |
toString()
A human readable representation of basic aspects of this activity instance. |
| Methods inherited from class org.eclipse.stardust.engine.api.dto.RuntimeObjectDetails |
|---|
equals, getModelElementID, getModelElementOID, getModelOID, getOID, hashCode |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.eclipse.stardust.engine.api.runtime.RuntimeObject |
|---|
getModelElementID, getModelElementOID, getModelOID, getOID |
| Field Detail |
|---|
public static final String PRP_PI_DETAILS_OPTIONS
| Method Detail |
|---|
public String getProcessID()
ProcessInstanceRuntimeObject.getModelElementID().
getProcessID in interface ProcessInstancepublic String getProcessName()
ProcessInstance
getProcessName in interface ProcessInstanceProcessInstance.getProcessName()public long getRootProcessInstanceOID()
ProcessInstanceRuntimeObject.getOID() for
top-level processes.
getRootProcessInstanceOID in interface ProcessInstancepublic long getScopeProcessInstanceOID()
ProcessInstance
getScopeProcessInstanceOID in interface ProcessInstancepublic ProcessInstance getScopeProcessInstance()
ProcessInstance
getScopeProcessInstance in interface ProcessInstancepublic int getPriority()
ProcessInstance
getPriority in interface ProcessInstancepublic Date getStartTime()
ProcessInstance
getStartTime in interface ProcessInstancepublic Date getTerminationTime()
ProcessInstance
getTerminationTime in interface ProcessInstancepublic User getStartingUser()
ProcessInstanceUser object of the user that have started the process instance.
getStartingUser in interface ProcessInstanceUser object of the user.public ProcessInstanceState getState()
ProcessInstance
getState in interface ProcessInstancepublic long getStartingActivityInstanceOID()
public long getParentProcessInstanceOid()
ProcessInstanceProcessInstanceDetailsOptions.WITH_HIERARCHY_INFO has been set at
ProcessInstanceDetailsPolicy.
getParentProcessInstanceOid in interface ProcessInstanceProcessInstance.UNKNOWN_OID will be
returned if an error occurred or details option has not been set.public Map<String,Object> getDescriptors()
public Object getDescriptorValue(String id)
IDescriptorProvider
getDescriptorValue in interface IDescriptorProviderid - the id of the descriptor.
public List<DataPath> getDescriptorDefinitions()
IDescriptorProvider
getDescriptorDefinitions in interface IDescriptorProvider
public static void initDescriptors(org.eclipse.stardust.engine.core.runtime.beans.IProcessInstance processInstance,
List<DataPath> descriptorDefinitions,
Map<String,Object> descriptors)
public static User initStartingUser(org.eclipse.stardust.engine.core.runtime.beans.IProcessInstance processInstance,
org.eclipse.stardust.common.config.Parameters parameters,
UserDetailsLevel userDetailsLevel)
public String toString()
Support Case Management: Create Case (02/09/20 10:10:10)
toString in class Objectpublic ProcessInstanceDetailsLevel getDetailsLevel()
ProcessInstance
getDetailsLevel in interface ProcessInstancepublic EnumSet<ProcessInstanceDetailsOptions> getDetailsOptions()
ProcessInstance
getDetailsOptions in interface ProcessInstancepublic ProcessInstanceAttributes getAttributes()
ProcessInstance
getAttributes in interface ProcessInstancepublic Map<String,Object> getRuntimeAttributes()
getRuntimeAttributes in interface ProcessInstancepublic List<HistoricalEvent> getHistoricalEvents()
ProcessInstanceHistoricalEventPolicy applied to
ProcessInstanceQuery. By default this list will be empty as
retrieval might degrade query performance.
getHistoricalEvents in interface ProcessInstanceHistoricalEvent,
HistoricalEventPolicypublic List<org.eclipse.stardust.engine.api.runtime.ProcessInstanceLink> getLinkedProcessInstances()
ProcessInstanceProcessInstanceDetailsOptions.WITH_LINK_INFO has been set at
ProcessInstanceDetailsPolicy.
getLinkedProcessInstances in interface ProcessInstancepublic boolean isCaseProcessInstance()
ProcessInstance
isCaseProcessInstance in interface ProcessInstanceWorkflowService.createCase(String, String, long[]),
WorkflowService.joinCase(long, long[]),
WorkflowService.leaveCase(long, long[]),
WorkflowService.mergeCases(long, long[], String)public PermissionState getPermission(String permissionId)
ProcessInstance
getPermission in interface ProcessInstancepublic long getBenchmark()
getBenchmark in interface ProcessInstancepublic org.eclipse.stardust.engine.core.benchmark.BenchmarkResult getBenchmarkResult()
getBenchmarkResult in interface ProcessInstancepublic String getRootProcessInstanceName()
ProcessInstanceProcessInstance.getProcessName() for
top-level processes.
getRootProcessInstanceName in interface ProcessInstancepublic List<org.eclipse.stardust.engine.api.dto.HistoricalData> getHistoricalData()
public String getBusinessCalendarId()
ProcessInstance
getBusinessCalendarId in interface ProcessInstance
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||