ProcessInstanceResponse (Flowable - Rest

java.lang.Object
- org.flowable.rest.service.api.runtime.process.ProcessInstanceResponse

```
public class ProcessInstanceResponse
extends Object
```
Modified to add a "completed" flag, which lets the caller know if the process instance has run to completion without encountering a wait state or experiencing an error/ exception.

Author:

Frederik Heremans, Ryan Johnston (@rjfsu)

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`activityId`
`protected String`	`businessKey`
`protected String`	`callbackId`
`protected String`	`callbackType`
`protected boolean`	`completed`
`protected boolean`	`ended`
`protected String`	`id`
`protected String`	`name`
`protected String`	`processDefinitionDescription`
`protected String`	`processDefinitionId`
`protected String`	`processDefinitionName`
`protected String`	`processDefinitionUrl`
`protected String`	`propagatedStageInstanceId`
`protected String`	`referenceId`
`protected String`	`referenceType`
`protected Date`	`startTime`
`protected String`	`startUserId`
`protected boolean`	`suspended`
`protected String`	`tenantId`
`protected String`	`url`
`protected List<RestVariable>`	`variables`

Constructor Summary

Constructors
Constructor and Description

ProcessInstanceResponse()

Constructors
Constructor and Description
`ProcessInstanceResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addVariable(RestVariable variable)`
`String`	`getActivityId()`
`String`	`getBusinessKey()`
`String`	`getCallbackId()`
`String`	`getCallbackType()`
`String`	`getId()`
`String`	`getName()`
`String`	`getProcessDefinitionDescription()`
`String`	`getProcessDefinitionId()`
`String`	`getProcessDefinitionName()`
`String`	`getProcessDefinitionUrl()`
`String`	`getPropagatedStageInstanceId()`
`String`	`getReferenceId()`
`String`	`getReferenceType()`
`Date`	`getStartTime()`
`String`	`getStartUserId()`
`String`	`getTenantId()`
`String`	`getUrl()`
`List<RestVariable>`	`getVariables()`
`boolean`	`isCompleted()`
`boolean`	`isEnded()`
`boolean`	`isSuspended()`
`void`	`setActivityId(String activityId)`
`void`	`setBusinessKey(String businessKey)`
`void`	`setCallbackId(String callbackId)`
`void`	`setCallbackType(String callbackType)`
`void`	`setCompleted(boolean completed)`
`void`	`setEnded(boolean ended)`
`void`	`setId(String id)`
`void`	`setName(String name)`
`void`	`setProcessDefinitionDescription(String processDefinitionDescription)`
`void`	`setProcessDefinitionId(String processDefinitionId)`
`void`	`setProcessDefinitionName(String processDefinitionName)`
`void`	`setProcessDefinitionUrl(String processDefinitionUrl)`
`void`	`setPropagatedStageInstanceId(String propagatedStageInstanceId)`
`void`	`setReferenceId(String referenceId)`
`void`	`setReferenceType(String referenceType)`
`void`	`setStartTime(Date startTime)`
`void`	`setStartUserId(String startUserId)`
`void`	`setSuspended(boolean suspended)`
`void`	`setTenantId(String tenantId)`
`void`	`setUrl(String url)`
`void`	`setVariables(List<RestVariable> variables)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id
```
protected String id
```

url
```
protected String url
```

name
```
protected String name
```

businessKey
```
protected String businessKey
```

suspended
```
protected boolean suspended
```

ended
```
protected boolean ended
```

processDefinitionId
```
protected String processDefinitionId
```

processDefinitionUrl
```
protected String processDefinitionUrl
```

processDefinitionName
```
protected String processDefinitionName
```

processDefinitionDescription

protected String processDefinitionDescription

activityId
```
protected String activityId
```

startUserId
```
protected String startUserId
```

startTime
```
protected Date startTime
```

variables
```
protected List<RestVariable> variables
```

callbackId
```
protected String callbackId
```

callbackType
```
protected String callbackType
```

referenceId
```
protected String referenceId
```

referenceType
```
protected String referenceType
```

propagatedStageInstanceId

protected String propagatedStageInstanceId

tenantId
```
protected String tenantId
```

completed
```
protected boolean completed
```

Constructor Detail
- ProcessInstanceResponse
```
public ProcessInstanceResponse()
```

Method Detail

getId
```
public String getId()
```

setId
```
public void setId(String id)
```

getUrl
```
public String getUrl()
```

setUrl
```
public void setUrl(String url)
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getBusinessKey
```
public String getBusinessKey()
```

setBusinessKey

public void setBusinessKey(String businessKey)

isSuspended
```
public boolean isSuspended()
```

setSuspended

public void setSuspended(boolean suspended)

isEnded
```
public boolean isEnded()
```

setEnded
```
public void setEnded(boolean ended)
```

getProcessDefinitionId

public String getProcessDefinitionId()

setProcessDefinitionId

public void setProcessDefinitionId(String processDefinitionId)

getProcessDefinitionUrl

public String getProcessDefinitionUrl()

setProcessDefinitionUrl

public void setProcessDefinitionUrl(String processDefinitionUrl)

getProcessDefinitionName

public String getProcessDefinitionName()

setProcessDefinitionName

public void setProcessDefinitionName(String processDefinitionName)

getProcessDefinitionDescription

public String getProcessDefinitionDescription()

setProcessDefinitionDescription

public void setProcessDefinitionDescription(String processDefinitionDescription)

getActivityId
```
public String getActivityId()
```

setActivityId

public void setActivityId(String activityId)

getStartUserId
```
public String getStartUserId()
```

setStartUserId

public void setStartUserId(String startUserId)

getStartTime
```
public Date getStartTime()
```

setStartTime

public void setStartTime(Date startTime)

getVariables

public List<RestVariable> getVariables()

setVariables

public void setVariables(List<RestVariable> variables)

addVariable

public void addVariable(RestVariable variable)

getCallbackId
```
public String getCallbackId()
```

setCallbackId

public void setCallbackId(String callbackId)

getCallbackType
```
public String getCallbackType()
```

setCallbackType

public void setCallbackType(String callbackType)

getReferenceId
```
public String getReferenceId()
```

setReferenceId

public void setReferenceId(String referenceId)

getReferenceType
```
public String getReferenceType()
```

setReferenceType

public void setReferenceType(String referenceType)

getPropagatedStageInstanceId

public String getPropagatedStageInstanceId()

setPropagatedStageInstanceId

public void setPropagatedStageInstanceId(String propagatedStageInstanceId)

setTenantId

public void setTenantId(String tenantId)

getTenantId
```
public String getTenantId()
```

isCompleted
```
public boolean isCompleted()
```

setCompleted

public void setCompleted(boolean completed)

Class ProcessInstanceResponse

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

url

name

businessKey

suspended

ended

processDefinitionId

processDefinitionUrl

processDefinitionName

processDefinitionDescription

activityId

startUserId

startTime

variables

callbackId

callbackType

referenceId

referenceType

propagatedStageInstanceId

tenantId

completed

Constructor Detail

ProcessInstanceResponse

Method Detail

getId

setId

getUrl

setUrl

getName

setName

getBusinessKey

setBusinessKey

isSuspended

setSuspended

isEnded

setEnded

getProcessDefinitionId

setProcessDefinitionId

getProcessDefinitionUrl

setProcessDefinitionUrl

getProcessDefinitionName

setProcessDefinitionName

getProcessDefinitionDescription

setProcessDefinitionDescription

getActivityId

setActivityId

getStartUserId

setStartUserId

getStartTime

setStartTime

getVariables

setVariables

addVariable

getCallbackId

setCallbackId

getCallbackType

setCallbackType

getReferenceId

setReferenceId

getReferenceType

setReferenceType

getPropagatedStageInstanceId

setPropagatedStageInstanceId

setTenantId

getTenantId

isCompleted

setCompleted