org.camunda.bpm.engine.rest.dto.runtime

Class ActivityInstanceDto

java.lang.Object

org.camunda.bpm.engine.rest.dto.runtime.ActivityInstanceDto

public class ActivityInstanceDto
extends Object

An activity instance is the instance of an activity

Author:

roman.smirnov

Field Summary

Fields

Modifier and Type	Field and Description
protected String	activityId
protected String	activityName
protected String	activityType
protected ActivityInstanceDto[]	childActivityInstances
protected TransitionInstanceDto[]	childTransitionInstances
protected String[]	executionIds
protected String	id
protected String[]	incidentIds
protected ActivityInstanceIncidentDto[]	incidents
protected String	parentActivityInstanceId
protected String	processDefinitionId
protected String	processInstanceId

Constructor Summary

Constructors

Constructor and Description
ActivityInstanceDto()

Method Summary

Modifier and Type	Method and Description
static ActivityInstanceDto	fromActivityInstance(ActivityInstance instance)
static ActivityInstanceDto[]	fromListOfActivityInstance(ActivityInstance[] instances)
String	getActivityId() the id of the activity
String	getActivityName() the activity name
String	getActivityType() type of the activity, corresponds to BPMN element name in XML (e.g.
ActivityInstanceDto[]	getChildActivityInstances() Returns the child activity instances.
TransitionInstanceDto[]	getChildTransitionInstances()
String[]	getExecutionIds() the list of executions that are currently waiting in this activity instance
String	getId() The id of the activity instance
String[]	getIncidentIds()
ActivityInstanceIncidentDto[]	getIncidents()
String	getName() deprecated; the JSON field with this name was never documented, but existed from 7.0 to 7.2
String	getParentActivityInstanceId() The id of the parent activity instance.
String	getProcessDefinitionId() the process definition id
String	getProcessInstanceId() the process instance id

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

protected String id

parentActivityInstanceId

protected String parentActivityInstanceId

activityId

protected String activityId

activityType

protected String activityType

processInstanceId

protected String processInstanceId

processDefinitionId

protected String processDefinitionId

childActivityInstances

protected ActivityInstanceDto[] childActivityInstances

childTransitionInstances

protected TransitionInstanceDto[] childTransitionInstances

executionIds

protected String[] executionIds

activityName

protected String activityName

incidentIds

protected String[] incidentIds

incidents

protected ActivityInstanceIncidentDto[] incidents

Constructor Detail

ActivityInstanceDto

public ActivityInstanceDto()

Method Detail

getId

public String getId()

The id of the activity instance

getParentActivityInstanceId

public String getParentActivityInstanceId()

The id of the parent activity instance. If the activity is the process definition, getId() and getParentActivityInstanceId() return the same value

getActivityId

public String getActivityId()

the id of the activity

getActivityType

public String getActivityType()

type of the activity, corresponds to BPMN element name in XML (e.g. 'userTask')

getProcessInstanceId

public String getProcessInstanceId()

the process instance id

getProcessDefinitionId

public String getProcessDefinitionId()

the process definition id

getChildActivityInstances

public ActivityInstanceDto[] getChildActivityInstances()

Returns the child activity instances. Returns an empty list if there are no child instances.

getChildTransitionInstances

public TransitionInstanceDto[] getChildTransitionInstances()

getExecutionIds

public String[] getExecutionIds()

the list of executions that are currently waiting in this activity instance

getActivityName

public String getActivityName()

the activity name

getName

public String getName()

deprecated; the JSON field with this name was never documented, but existed from 7.0 to 7.2

getIncidentIds

public String[] getIncidentIds()

getIncidents

public ActivityInstanceIncidentDto[] getIncidents()

fromActivityInstance

public static ActivityInstanceDto fromActivityInstance(ActivityInstance instance)

fromListOfActivityInstance

public static ActivityInstanceDto[] fromListOfActivityInstance(ActivityInstance[] instances)