org.eclipse.stardust.engine.api.ws
Class ProcessInstanceXto

java.lang.Object
  extended by org.eclipse.stardust.engine.api.ws.ProcessInstanceXto

public class ProcessInstanceXto
extends Object

The ProcessInstance represents a snapshot of the execution state of an process instance.

Java class for ProcessInstance complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ProcessInstance">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="oid" type="{http://www.w3.org/2001/XMLSchema}long"/>
         <element name="modelElementId" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="modelElementOid" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="modelOid" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="processDefinitionId" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="processDefinitionName" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="rootProcessOid" type="{http://www.w3.org/2001/XMLSchema}long"/>
         <element name="scopeProcessOid" type="{http://www.w3.org/2001/XMLSchema}long"/>
         <element name="parentProcessOid" type="{http://www.w3.org/2001/XMLSchema}long"/>
         <element name="priority" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="startTime" type="{http://www.w3.org/2001/XMLSchema}dateTime"/>
         <element name="terminationTime" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="startingUser" type="{http://eclipse.org/stardust/ws/v2012a/api}User" minOccurs="0"/>
         <element name="benchmark" type="{http://www.w3.org/2001/XMLSchema}long"/>
         <element name="benchmarkResult" type="{http://eclipse.org/stardust/ws/v2012a/api}BenchmarkResult"/>
         <element name="state" type="{http://eclipse.org/stardust/ws/v2012a/api}ProcessInstanceState"/>
         <element name="detailsLevel" type="{http://eclipse.org/stardust/ws/v2012a/api}ProcessInstanceDetailsLevel"/>
         <element name="detailsOptions" type="{http://eclipse.org/stardust/ws/v2012a/api}ProcessInstanceDetailsOptions"/>
         <element name="instanceProperties" type="{http://eclipse.org/stardust/ws/v2012a/api}InstanceProperties" minOccurs="0"/>
         <element name="historicalEvents" type="{http://eclipse.org/stardust/ws/v2012a/api}HistoricalEvents" minOccurs="0"/>
         <element name="permissionStates" type="{http://eclipse.org/stardust/ws/v2012a/api}PermissionStates" minOccurs="0"/>
         <element name="caseProcessInstance" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="linkedProcessInstances" type="{http://eclipse.org/stardust/ws/v2012a/api}ProcessInstanceLinks" minOccurs="0"/>
         <element name="descriptorDefinitions" type="{http://eclipse.org/stardust/ws/v2012a/api}DataPaths" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 


Constructor Summary
ProcessInstanceXto()
           
 
Method Summary
 long getBenchmark()
          Gets the value of the benchmark property.
 BenchmarkResultXto getBenchmarkResult()
          Gets the value of the benchmarkResult property.
 DataPathsXto getDescriptorDefinitions()
          Gets the value of the descriptorDefinitions property.
 ProcessInstanceDetailsLevelXto getDetailsLevel()
          Gets the value of the detailsLevel property.
 ProcessInstanceDetailsOptionsXto getDetailsOptions()
          Gets the value of the detailsOptions property.
 HistoricalEventsXto getHistoricalEvents()
          Gets the value of the historicalEvents property.
 InstancePropertiesXto getInstanceProperties()
          Gets the value of the instanceProperties property.
 ProcessInstanceLinksXto getLinkedProcessInstances()
          Gets the value of the linkedProcessInstances property.
 String getModelElementId()
          Gets the value of the modelElementId property.
 int getModelElementOid()
          Gets the value of the modelElementOid property.
 int getModelOid()
          Gets the value of the modelOid property.
 long getOid()
          Gets the value of the oid property.
 long getParentProcessOid()
          Gets the value of the parentProcessOid property.
 PermissionStatesXto getPermissionStates()
          Gets the value of the permissionStates property.
 int getPriority()
          Gets the value of the priority property.
 String getProcessDefinitionId()
          Gets the value of the processDefinitionId property.
 String getProcessDefinitionName()
          Gets the value of the processDefinitionName property.
 long getRootProcessOid()
          Gets the value of the rootProcessOid property.
 long getScopeProcessOid()
          Gets the value of the scopeProcessOid property.
 UserXto getStartingUser()
          Gets the value of the startingUser property.
 Date getStartTime()
          Gets the value of the startTime property.
 org.eclipse.stardust.engine.api.runtime.ProcessInstanceState getState()
          Gets the value of the state property.
 Date getTerminationTime()
          Gets the value of the terminationTime property.
 boolean isCaseProcessInstance()
          Gets the value of the caseProcessInstance property.
 void setBenchmark(long value)
          Sets the value of the benchmark property.
 void setBenchmarkResult(BenchmarkResultXto value)
          Sets the value of the benchmarkResult property.
 void setCaseProcessInstance(boolean value)
          Sets the value of the caseProcessInstance property.
 void setDescriptorDefinitions(DataPathsXto value)
          Sets the value of the descriptorDefinitions property.
 void setDetailsLevel(ProcessInstanceDetailsLevelXto value)
          Sets the value of the detailsLevel property.
 void setDetailsOptions(ProcessInstanceDetailsOptionsXto value)
          Sets the value of the detailsOptions property.
 void setHistoricalEvents(HistoricalEventsXto value)
          Sets the value of the historicalEvents property.
 void setInstanceProperties(InstancePropertiesXto value)
          Sets the value of the instanceProperties property.
 void setLinkedProcessInstances(ProcessInstanceLinksXto value)
          Sets the value of the linkedProcessInstances property.
 void setModelElementId(String value)
          Sets the value of the modelElementId property.
 void setModelElementOid(int value)
          Sets the value of the modelElementOid property.
 void setModelOid(int value)
          Sets the value of the modelOid property.
 void setOid(long value)
          Sets the value of the oid property.
 void setParentProcessOid(long value)
          Sets the value of the parentProcessOid property.
 void setPermissionStates(PermissionStatesXto value)
          Sets the value of the permissionStates property.
 void setPriority(int value)
          Sets the value of the priority property.
 void setProcessDefinitionId(String value)
          Sets the value of the processDefinitionId property.
 void setProcessDefinitionName(String value)
          Sets the value of the processDefinitionName property.
 void setRootProcessOid(long value)
          Sets the value of the rootProcessOid property.
 void setScopeProcessOid(long value)
          Sets the value of the scopeProcessOid property.
 void setStartingUser(UserXto value)
          Sets the value of the startingUser property.
 void setStartTime(Date value)
          Sets the value of the startTime property.
 void setState(org.eclipse.stardust.engine.api.runtime.ProcessInstanceState value)
          Sets the value of the state property.
 void setTerminationTime(Date value)
          Sets the value of the terminationTime property.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProcessInstanceXto

public ProcessInstanceXto()
Method Detail

getOid

public long getOid()
Gets the value of the oid property.


setOid

public void setOid(long value)
Sets the value of the oid property.


getModelElementId

public String getModelElementId()
Gets the value of the modelElementId property.

Returns:
possible object is String

setModelElementId

public void setModelElementId(String value)
Sets the value of the modelElementId property.

Parameters:
value - allowed object is String

getModelElementOid

public int getModelElementOid()
Gets the value of the modelElementOid property.


setModelElementOid

public void setModelElementOid(int value)
Sets the value of the modelElementOid property.


getModelOid

public int getModelOid()
Gets the value of the modelOid property.


setModelOid

public void setModelOid(int value)
Sets the value of the modelOid property.


getProcessDefinitionId

public String getProcessDefinitionId()
Gets the value of the processDefinitionId property.

Returns:
possible object is String

setProcessDefinitionId

public void setProcessDefinitionId(String value)
Sets the value of the processDefinitionId property.

Parameters:
value - allowed object is String

getProcessDefinitionName

public String getProcessDefinitionName()
Gets the value of the processDefinitionName property.

Returns:
possible object is String

setProcessDefinitionName

public void setProcessDefinitionName(String value)
Sets the value of the processDefinitionName property.

Parameters:
value - allowed object is String

getRootProcessOid

public long getRootProcessOid()
Gets the value of the rootProcessOid property.


setRootProcessOid

public void setRootProcessOid(long value)
Sets the value of the rootProcessOid property.


getScopeProcessOid

public long getScopeProcessOid()
Gets the value of the scopeProcessOid property.


setScopeProcessOid

public void setScopeProcessOid(long value)
Sets the value of the scopeProcessOid property.


getParentProcessOid

public long getParentProcessOid()
Gets the value of the parentProcessOid property.


setParentProcessOid

public void setParentProcessOid(long value)
Sets the value of the parentProcessOid property.


getPriority

public int getPriority()
Gets the value of the priority property.


setPriority

public void setPriority(int value)
Sets the value of the priority property.


getStartTime

public Date getStartTime()
Gets the value of the startTime property.

Returns:
possible object is String

setStartTime

public void setStartTime(Date value)
Sets the value of the startTime property.

Parameters:
value - allowed object is String

getTerminationTime

public Date getTerminationTime()
Gets the value of the terminationTime property.

Returns:
possible object is String

setTerminationTime

public void setTerminationTime(Date value)
Sets the value of the terminationTime property.

Parameters:
value - allowed object is String

getStartingUser

public UserXto getStartingUser()
Gets the value of the startingUser property.

Returns:
possible object is UserXto

setStartingUser

public void setStartingUser(UserXto value)
Sets the value of the startingUser property.

Parameters:
value - allowed object is UserXto

getBenchmark

public long getBenchmark()
Gets the value of the benchmark property.


setBenchmark

public void setBenchmark(long value)
Sets the value of the benchmark property.


getBenchmarkResult

public BenchmarkResultXto getBenchmarkResult()
Gets the value of the benchmarkResult property.

Returns:
possible object is BenchmarkResultXto

setBenchmarkResult

public void setBenchmarkResult(BenchmarkResultXto value)
Sets the value of the benchmarkResult property.

Parameters:
value - allowed object is BenchmarkResultXto

getState

public org.eclipse.stardust.engine.api.runtime.ProcessInstanceState getState()
Gets the value of the state property.

Returns:
possible object is String

setState

public void setState(org.eclipse.stardust.engine.api.runtime.ProcessInstanceState value)
Sets the value of the state property.

Parameters:
value - allowed object is String

getDetailsLevel

public ProcessInstanceDetailsLevelXto getDetailsLevel()
Gets the value of the detailsLevel property.

Returns:
possible object is ProcessInstanceDetailsLevelXto

setDetailsLevel

public void setDetailsLevel(ProcessInstanceDetailsLevelXto value)
Sets the value of the detailsLevel property.

Parameters:
value - allowed object is ProcessInstanceDetailsLevelXto

getDetailsOptions

public ProcessInstanceDetailsOptionsXto getDetailsOptions()
Gets the value of the detailsOptions property.

Returns:
possible object is ProcessInstanceDetailsOptionsXto

setDetailsOptions

public void setDetailsOptions(ProcessInstanceDetailsOptionsXto value)
Sets the value of the detailsOptions property.

Parameters:
value - allowed object is ProcessInstanceDetailsOptionsXto

getInstanceProperties

public InstancePropertiesXto getInstanceProperties()
Gets the value of the instanceProperties property.

Returns:
possible object is InstancePropertiesXto

setInstanceProperties

public void setInstanceProperties(InstancePropertiesXto value)
Sets the value of the instanceProperties property.

Parameters:
value - allowed object is InstancePropertiesXto

getHistoricalEvents

public HistoricalEventsXto getHistoricalEvents()
Gets the value of the historicalEvents property.

Returns:
possible object is HistoricalEventsXto

setHistoricalEvents

public void setHistoricalEvents(HistoricalEventsXto value)
Sets the value of the historicalEvents property.

Parameters:
value - allowed object is HistoricalEventsXto

getPermissionStates

public PermissionStatesXto getPermissionStates()
Gets the value of the permissionStates property.

Returns:
possible object is PermissionStatesXto

setPermissionStates

public void setPermissionStates(PermissionStatesXto value)
Sets the value of the permissionStates property.

Parameters:
value - allowed object is PermissionStatesXto

isCaseProcessInstance

public boolean isCaseProcessInstance()
Gets the value of the caseProcessInstance property.


setCaseProcessInstance

public void setCaseProcessInstance(boolean value)
Sets the value of the caseProcessInstance property.


getLinkedProcessInstances

public ProcessInstanceLinksXto getLinkedProcessInstances()
Gets the value of the linkedProcessInstances property.

Returns:
possible object is ProcessInstanceLinksXto

setLinkedProcessInstances

public void setLinkedProcessInstances(ProcessInstanceLinksXto value)
Sets the value of the linkedProcessInstances property.

Parameters:
value - allowed object is ProcessInstanceLinksXto

getDescriptorDefinitions

public DataPathsXto getDescriptorDefinitions()
Gets the value of the descriptorDefinitions property.

Returns:
possible object is DataPathsXto

setDescriptorDefinitions

public void setDescriptorDefinitions(DataPathsXto value)
Sets the value of the descriptorDefinitions property.

Parameters:
value - allowed object is DataPathsXto


Copyright © 2017 Eclipse Stardust. All Rights Reserved.