ChangePlanItemStateBuilder (Flowable

```
public interface ChangePlanItemStateBuilder
```
Helper for changing the state of a case instance. An instance can be obtained through CmmnRuntimeService.createChangePlanItemStateBuilder().

Author:

Tijs Rademakers

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ChangePlanItemStateBuilder`	`activatePlanItemDefinition(ActivatePlanItemDefinitionMapping planItemDefinitionMapping)` Activate a plan item by definition mapping.
`ChangePlanItemStateBuilder`	`activatePlanItemDefinitionId(String planItemDefinitionId)` Activate a plan item by definition id.
`ChangePlanItemStateBuilder`	`activatePlanItemDefinitionIds(List<String> planItemDefinitionIds)` Activate multiple plan items by definition id.
`ChangePlanItemStateBuilder`	`activatePlanItemDefinitions(List<ActivatePlanItemDefinitionMapping> planItemDefinitionMappings)` Activate multiple plan items by definition mapping.
`ChangePlanItemStateBuilder`	`caseInstanceId(String caseInstanceId)` Set the id of the case instance
`ChangePlanItemStateBuilder`	`caseVariable(String caseVariableName, Object caseVariableValue)` Set the case variable that should be set as part of the change plan item state action.
`ChangePlanItemStateBuilder`	`caseVariables(Map<String,Object> caseVariables)` Set the case variable that should be set as part of the change plan item state action.
`void`	`changeState()` Changes the case instance state
`ChangePlanItemStateBuilder`	`changeToAvailableStateByPlanItemDefinitionId(String planItemDefinitionId)` Set a plan item to available state by definition id.
`ChangePlanItemStateBuilder`	`changeToAvailableStateByPlanItemDefinitionIds(List<String> planItemDefinitionIds)` Set multiple plan items to available state by definition id.
`ChangePlanItemStateBuilder`	`childInstanceTaskVariable(String planItemDefinitionId, String name, Object value)` Set the case variable that should be set as part of the change process or case task state action.
`ChangePlanItemStateBuilder`	`childInstanceTaskVariables(String planItemDefinitionId, Map<String,Object> variables)` Set the case variable that should be set as part of the change process or case task state action.
`ChangePlanItemStateBuilder`	`terminatePlanItemDefinitionId(String planItemDefinitionId)` Terminate a plan item by definition id without terminating another plan item instance.
`ChangePlanItemStateBuilder`	`terminatePlanItemDefinitionIds(List<String> planItemDefinitionIds)` Terminate multiple plan items by definition id without terminating another plan item instance.

Method Detail

caseInstanceId

ChangePlanItemStateBuilder caseInstanceId(String caseInstanceId)

Set the id of the case instance

activatePlanItemDefinitionId

ChangePlanItemStateBuilder activatePlanItemDefinitionId(String planItemDefinitionId)

Activate a plan item by definition id.

activatePlanItemDefinitionIds

ChangePlanItemStateBuilder activatePlanItemDefinitionIds(List<String> planItemDefinitionIds)

Activate multiple plan items by definition id.

activatePlanItemDefinition

ChangePlanItemStateBuilder activatePlanItemDefinition(ActivatePlanItemDefinitionMapping planItemDefinitionMapping)

Activate a plan item by definition mapping.

activatePlanItemDefinitions

ChangePlanItemStateBuilder activatePlanItemDefinitions(List<ActivatePlanItemDefinitionMapping> planItemDefinitionMappings)

Activate multiple plan items by definition mapping.

changeToAvailableStateByPlanItemDefinitionId

ChangePlanItemStateBuilder changeToAvailableStateByPlanItemDefinitionId(String planItemDefinitionId)

Set a plan item to available state by definition id.

changeToAvailableStateByPlanItemDefinitionIds

ChangePlanItemStateBuilder changeToAvailableStateByPlanItemDefinitionIds(List<String> planItemDefinitionIds)

Set multiple plan items to available state by definition id.

terminatePlanItemDefinitionId
```
ChangePlanItemStateBuilder terminatePlanItemDefinitionId(String planItemDefinitionId)
```
Terminate a plan item by definition id without terminating another plan item instance.

terminatePlanItemDefinitionIds
```
ChangePlanItemStateBuilder terminatePlanItemDefinitionIds(List<String> planItemDefinitionIds)
```
Terminate multiple plan items by definition id without terminating another plan item instance.

caseVariable

ChangePlanItemStateBuilder caseVariable(String caseVariableName,
                                        Object caseVariableValue)

Set the case variable that should be set as part of the change plan item state action.

caseVariables
```
ChangePlanItemStateBuilder caseVariables(Map<String,Object> caseVariables)
```
Set the case variable that should be set as part of the change plan item state action.

childInstanceTaskVariable

ChangePlanItemStateBuilder childInstanceTaskVariable(String planItemDefinitionId,
                                                     String name,
                                                     Object value)

Set the case variable that should be set as part of the change process or case task state action.

childInstanceTaskVariables

ChangePlanItemStateBuilder childInstanceTaskVariables(String planItemDefinitionId,
                                                      Map<String,Object> variables)