org.flowable.cmmn.api.runtime

Interface ChangePlanItemStateBuilder

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

Modifier and Type	Method and Description
ChangePlanItemStateBuilder	activatePlanItemDefinitionId(String planItemDefinitionId) Activate a plan item by definition id without terminating another plan item instance.
ChangePlanItemStateBuilder	activatePlanItemDefinitionIds(List<String> planItemDefinitionIds) Activate multiple plan items by definition id without terminating another plan item instance.
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.
ChangePlanItemStateBuilder	changePlanItemInstancesToAvailableByPlanItemDefinitionId(List<String> planItemDefinitionIds) Set multiple enabled or active plan items to available state by definition id.
ChangePlanItemStateBuilder	changePlanItemInstanceToAvailableByPlanItemDefinitionId(String planItemDefinitionId) Set an enabled or active plan item to available state by definition id.
void	changeState() Changes the case instance state
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	movePlanItemDefinitionIdsToSinglePlanItemDefinitionId(List<String> currentPlanItemDefinitionIds, String newPlanItemDefinitionId) Set the plan item definition ids that should be changed to a single plan item definition id.
ChangePlanItemStateBuilder	movePlanItemDefinitionIdTo(String currentPlanItemDefinitionId, String newPlanItemDefinitionId) Moves the plan item instance with the current plan item definition id to the provided new plan item definition id
ChangePlanItemStateBuilder	movePlanItemInstancesToSinglePlanItemDefinitionId(List<String> planItemInstanceIds, String planItemDefinitionId) Set the ids of the plan item instances which should be changed to a single plan item instance with the provided plan item definition id.
ChangePlanItemStateBuilder	movePlanItemInstanceToPlanItemDefinitionId(String planItemInstanceId, String planItemDefinitionId) Set the id of the plan item instance for which the plan item state should be changed
ChangePlanItemStateBuilder	moveSinglePlanItemDefinitionIdToPlanItemDefinitionIds(String currentPlanItemDefinitionId, List<String> newPlanItemDefinitionIds) Set the plan item definition id that should be changed to multiple plan item definition ids.
ChangePlanItemStateBuilder	moveSinglePlanItemInstanceToPlanItemDefinitionIds(String planItemInstanceId, List<String> planItemDefinitionIds) Set the id of a plan item instance which should be changed to multiple plan item instances with the provided plan item definition ids.

Method Detail

caseInstanceId

ChangePlanItemStateBuilder caseInstanceId(String caseInstanceId)

Set the id of the case instance

movePlanItemInstanceToPlanItemDefinitionId

ChangePlanItemStateBuilder movePlanItemInstanceToPlanItemDefinitionId(String planItemInstanceId,
                                                                      String planItemDefinitionId)

Set the id of the plan item instance for which the plan item state should be changed

movePlanItemInstancesToSinglePlanItemDefinitionId

ChangePlanItemStateBuilder movePlanItemInstancesToSinglePlanItemDefinitionId(List<String> planItemInstanceIds,
                                                                             String planItemDefinitionId)

Set the ids of the plan item instances which should be changed to a single plan item instance with the provided plan item definition id.

moveSinglePlanItemInstanceToPlanItemDefinitionIds

ChangePlanItemStateBuilder moveSinglePlanItemInstanceToPlanItemDefinitionIds(String planItemInstanceId,
                                                                             List<String> planItemDefinitionIds)

Set the id of a plan item instance which should be changed to multiple plan item instances with the provided plan item definition ids.

movePlanItemDefinitionIdTo

ChangePlanItemStateBuilder movePlanItemDefinitionIdTo(String currentPlanItemDefinitionId,
                                                      String newPlanItemDefinitionId)

Moves the plan item instance with the current plan item definition id to the provided new plan item definition id

movePlanItemDefinitionIdsToSinglePlanItemDefinitionId

ChangePlanItemStateBuilder movePlanItemDefinitionIdsToSinglePlanItemDefinitionId(List<String> currentPlanItemDefinitionIds,
                                                                                 String newPlanItemDefinitionId)

Set the plan item definition ids that should be changed to a single plan item definition id.

moveSinglePlanItemDefinitionIdToPlanItemDefinitionIds

ChangePlanItemStateBuilder moveSinglePlanItemDefinitionIdToPlanItemDefinitionIds(String currentPlanItemDefinitionId,
                                                                                 List<String> newPlanItemDefinitionIds)

Set the plan item definition id that should be changed to multiple plan item definition ids.

activatePlanItemDefinitionId

ChangePlanItemStateBuilder activatePlanItemDefinitionId(String planItemDefinitionId)

Activate a plan item by definition id without terminating another plan item instance.

activatePlanItemDefinitionIds

ChangePlanItemStateBuilder activatePlanItemDefinitionIds(List<String> planItemDefinitionIds)

Activate multiple plan items by definition id without terminating another plan item instance.

changePlanItemInstanceToAvailableByPlanItemDefinitionId

ChangePlanItemStateBuilder changePlanItemInstanceToAvailableByPlanItemDefinitionId(String planItemDefinitionId)

Set an enabled or active plan item to available state by definition id.

changePlanItemInstancesToAvailableByPlanItemDefinitionId

ChangePlanItemStateBuilder changePlanItemInstancesToAvailableByPlanItemDefinitionId(List<String> planItemDefinitionIds)

Set multiple enabled or active plan items to available state by definition id.

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)

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

changeState

void changeState()

Changes the case instance state

Throws:

FlowableObjectNotFoundException - when no case instance is found

FlowableException - plan item instance could not be canceled or started