org.flowable.cmmn.engine.impl.runtime

Class CmmnRuntimeServiceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<C>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<CmmnEngineConfiguration>

org.flowable.cmmn.engine.impl.runtime.CmmnRuntimeServiceImpl

All Implemented Interfaces:

CmmnRuntimeService

public class CmmnRuntimeServiceImpl
extends CommonEngineServiceImpl<CmmnEngineConfiguration>
implements CmmnRuntimeService

Author:

Joram Barrez

Field Summary

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor and Description
CmmnRuntimeServiceImpl(CmmnEngineConfiguration engineConfiguration)

Method Summary

Modifier and Type	Method and Description
void	addGroupIdentityLink(String caseInstanceId, String groupId, String identityLinkType) Involves a group with a case instance.
void	addUserIdentityLink(String caseInstanceId, String userId, String identityLinkType) Involves a user with a case instance.
void	changePlanItemState(ChangePlanItemStateBuilderImpl changePlanItemStateBuilder)
void	completeCaseInstance(String caseInstanceId)
void	completeGenericEventListenerInstance(String genericEventListenerInstanceId)
void	completeStagePlanItemInstance(String planItemInstanceId)
void	completeStagePlanItemInstance(String planItemInstanceId, boolean force)
void	completeUserEventListenerInstance(String userEventListenerInstanceId)
CaseInstanceBuilder	createCaseInstanceBuilder()
CaseInstanceQuery	createCaseInstanceQuery()
ChangePlanItemStateBuilder	createChangePlanItemStateBuilder() Create a ChangePlanItemStateBuilder, that allows to set various options for changing the state of a process instance.
EventSubscriptionQuery	createEventSubscriptionQuery() Creates a new EventSubscriptionQuery instance, that can be used to query the event subscriptions.
GenericEventListenerInstanceQuery	createGenericEventListenerInstanceQuery()
MilestoneInstanceQuery	createMilestoneInstanceQuery()
PlanItemInstanceQuery	createPlanItemInstanceQuery()
PlanItemInstanceTransitionBuilder	createPlanItemInstanceTransitionBuilder(String planItemInstanceId)
SignalEventListenerInstanceQuery	createSignalEventListenerInstanceQuery()
UserEventListenerInstanceQuery	createUserEventListenerInstanceQuery()
void	deleteCaseInstance(String caseInstanceId)
void	deleteGroupIdentityLink(String caseInstanceId, String groupId, String identityLinkType) Removes the association between a group and a process instance for the given identityLinkType.
void	deleteUserIdentityLink(String caseInstanceId, String userId, String identityLinkType) Removes the association between a user and a process instance for the given identityLinkType.
void	disablePlanItemInstance(String planItemInstanceId)
void	enablePlanItemInstance(String planItemInstanceId)
void	evaluateCriteria(String caseInstanceId)
List<EntityLink>	getEntityLinkChildrenForCaseInstance(String caseInstanceId) Retrieves the EntityLinks associated with the given case instance.
List<EntityLink>	getEntityLinkChildrenWithSameRootAsCaseInstance(String instanceId) Retrieves all the EntityLinks associated with the same root as the given case instance.
List<EntityLink>	getEntityLinkParentsForCaseInstance(String caseInstanceId) Retrieves the EntityLinks where the given case instance is referenced.
List<IdentityLink>	getIdentityLinksForCaseInstance(String caseInstanceId) Retrieves the IdentityLinks associated with the given case instance.
List<IdentityLink>	getIdentityLinksForPlanItemInstance(String planItemInstanceId) Retrieves the IdentityLinks associated with the given plan item instance.
Object	getLocalVariable(String planItemInstanceId, String variableName) The local variable value.
VariableInstance	getLocalVariableInstance(String planItemInstanceId, String variableName) The local variable.
Map<String,VariableInstance>	getLocalVariableInstances(String planItemInstanceId) All variable values that are defined in the plan item instance scope, without taking outer scopes into account.
Map<String,Object>	getLocalVariables(String planItemInstanceId) All variable values that are defined in the plan item instance scope, without taking outer scopes into account.
List<StageResponse>	getStageOverview(String caseInstanceId) Gives back a stage overview of the case instance which includes the stage information of the case model.
FormInfo	getStartFormModel(String caseDefinitionId, String caseInstanceId) Gets a Form model instance of the start form of a specific case definition or case instance
Object	getVariable(String caseInstanceId, String variableName) The variable value.
VariableInstance	getVariableInstance(String caseInstanceId, String variableName) The variable.
Map<String,VariableInstance>	getVariableInstances(String caseInstanceId) All variables visible from the given case instance scope.
Map<String,Object>	getVariables(String caseInstanceId) All variables visible from the given case instance scope.
boolean	hasVariable(String caseInstanceId, String variableName) Check whether or not this case instance has variable set with the given name, Searching for the variable is done in all scopes that are visible to the given case instance.
void	removeLocalVariable(String planItemInstanceId, String variableName)
void	removeLocalVariables(String planItemInstanceId, Collection<String> variableNames)
void	removeVariable(String caseInstanceId, String variableName)
void	removeVariables(String caseInstanceId, Collection<String> variableNames)
void	setCaseInstanceName(String caseInstanceId, String caseName) Set or change the name of the case instance.
void	setLocalVariable(String planItemInstanceId, String variableName, Object variableValue)
void	setLocalVariables(String planItemInstanceId, Map<String,Object> variables)
void	setVariable(String caseInstanceId, String variableName, Object variableValue)
void	setVariables(String caseInstanceId, Map<String,Object> variables)
CaseInstance	startCaseInstance(CaseInstanceBuilder caseInstanceBuilder)
CaseInstance	startCaseInstanceAsync(CaseInstanceBuilder caseInstanceBuilder)
void	startPlanItemInstance(String planItemInstanceId)
void	terminateCaseInstance(String caseInstanceId)
void	terminatePlanItemInstance(String planItemInstanceId)
void	triggerPlanItemInstance(String planItemInstanceId)
void	updateBusinessKey(String caseInstanceId, String businessKey) Updates the business key for the provided case instance

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

CmmnRuntimeServiceImpl

public CmmnRuntimeServiceImpl(CmmnEngineConfiguration engineConfiguration)

Method Detail

createCaseInstanceBuilder

public CaseInstanceBuilder createCaseInstanceBuilder()

Specified by:

createCaseInstanceBuilder in interface CmmnRuntimeService

createPlanItemInstanceTransitionBuilder

public PlanItemInstanceTransitionBuilder createPlanItemInstanceTransitionBuilder(String planItemInstanceId)

Specified by:

createPlanItemInstanceTransitionBuilder in interface CmmnRuntimeService

startCaseInstance

public CaseInstance startCaseInstance(CaseInstanceBuilder caseInstanceBuilder)

startCaseInstanceAsync

public CaseInstance startCaseInstanceAsync(CaseInstanceBuilder caseInstanceBuilder)

getStartFormModel

public FormInfo getStartFormModel(String caseDefinitionId,
                                  String caseInstanceId)

Description copied from interface: CmmnRuntimeService

Gets a Form model instance of the start form of a specific case definition or case instance

Specified by:

getStartFormModel in interface CmmnRuntimeService

Parameters:

caseDefinitionId - id of case definition for which the start form should be retrieved.

caseInstanceId - id of case instance for which the start form should be retrieved.

triggerPlanItemInstance

public void triggerPlanItemInstance(String planItemInstanceId)

Specified by:

triggerPlanItemInstance in interface CmmnRuntimeService

enablePlanItemInstance

public void enablePlanItemInstance(String planItemInstanceId)

Specified by:

enablePlanItemInstance in interface CmmnRuntimeService

disablePlanItemInstance

public void disablePlanItemInstance(String planItemInstanceId)

Specified by:

disablePlanItemInstance in interface CmmnRuntimeService

completeStagePlanItemInstance

public void completeStagePlanItemInstance(String planItemInstanceId)

Specified by:

completeStagePlanItemInstance in interface CmmnRuntimeService

completeStagePlanItemInstance

public void completeStagePlanItemInstance(String planItemInstanceId,
                                          boolean force)

Specified by:

completeStagePlanItemInstance in interface CmmnRuntimeService

startPlanItemInstance

public void startPlanItemInstance(String planItemInstanceId)

Specified by:

startPlanItemInstance in interface CmmnRuntimeService

completeCaseInstance

public void completeCaseInstance(String caseInstanceId)

Specified by:

completeCaseInstance in interface CmmnRuntimeService

terminateCaseInstance

public void terminateCaseInstance(String caseInstanceId)

Specified by:

terminateCaseInstance in interface CmmnRuntimeService

terminatePlanItemInstance

public void terminatePlanItemInstance(String planItemInstanceId)

Specified by:

terminatePlanItemInstance in interface CmmnRuntimeService

deleteCaseInstance

public void deleteCaseInstance(String caseInstanceId)

Specified by:

deleteCaseInstance in interface CmmnRuntimeService

evaluateCriteria

public void evaluateCriteria(String caseInstanceId)

Specified by:

evaluateCriteria in interface CmmnRuntimeService

completeGenericEventListenerInstance

public void completeGenericEventListenerInstance(String genericEventListenerInstanceId)

Specified by:

completeGenericEventListenerInstance in interface CmmnRuntimeService

completeUserEventListenerInstance

public void completeUserEventListenerInstance(String userEventListenerInstanceId)

Specified by:

completeUserEventListenerInstance in interface CmmnRuntimeService

getVariables

public Map<String,Object> getVariables(String caseInstanceId)

Description copied from interface: CmmnRuntimeService

All variables visible from the given case instance scope.

Specified by:

getVariables in interface CmmnRuntimeService

Parameters:

caseInstanceId - id of case instance, cannot be null.

Returns:

the variables or an empty map if no such variables are found.

getVariableInstances

public Map<String,VariableInstance> getVariableInstances(String caseInstanceId)

Description copied from interface: CmmnRuntimeService

All variables visible from the given case instance scope.

Specified by:

getVariableInstances in interface CmmnRuntimeService

Parameters:

caseInstanceId - id of case instance, cannot be null.

Returns:

the variable instances or an empty map if no such variables are found.

getLocalVariables

public Map<String,Object> getLocalVariables(String planItemInstanceId)

Description copied from interface: CmmnRuntimeService

All variable values that are defined in the plan item instance scope, without taking outer scopes into account.

Specified by:

getLocalVariables in interface CmmnRuntimeService

Parameters:

planItemInstanceId - id of plan item instance, cannot be null.

Returns:

the variables or an empty map if no such variables are found.

getLocalVariableInstances

public Map<String,VariableInstance> getLocalVariableInstances(String planItemInstanceId)

Description copied from interface: CmmnRuntimeService

All variable values that are defined in the plan item instance scope, without taking outer scopes into account.

Specified by:

getLocalVariableInstances in interface CmmnRuntimeService

Parameters:

planItemInstanceId - id of plan item instance, cannot be null.

Returns:

the variables or an empty map if no such variables are found.

getVariable

public Object getVariable(String caseInstanceId,
                          String variableName)

Description copied from interface: CmmnRuntimeService

The variable value. Returns null when no variable value is found with the given name or when the value is set to null.

Specified by:

getVariable in interface CmmnRuntimeService

Parameters:

caseInstanceId - id of case instance, cannot be null.

variableName - name of variable, cannot be null.

Returns:

the variable value or null if the variable is undefined or the value of the variable is null.

getVariableInstance

public VariableInstance getVariableInstance(String caseInstanceId,
                                            String variableName)

Description copied from interface: CmmnRuntimeService

The variable. Returns null when no variable value is found with the given name or when the value is set to null.

Specified by:

getVariableInstance in interface CmmnRuntimeService

Parameters:

caseInstanceId - id of case instance, cannot be null.

variableName - name of variable, cannot be null.

Returns:

the variable or null if the variable is undefined.

getLocalVariable

public Object getLocalVariable(String planItemInstanceId,
                               String variableName)

Description copied from interface: CmmnRuntimeService

The local variable value. Returns null when no variable value is found with the given name or when the value is set to null.

Specified by:

getLocalVariable in interface CmmnRuntimeService

Parameters:

planItemInstanceId - id of plan item instance, cannot be null.

variableName - name of variable, cannot be null.

Returns:

the variable value or null if the variable is undefined or the value of the variable is null.

getLocalVariableInstance

public VariableInstance getLocalVariableInstance(String planItemInstanceId,
                                                 String variableName)

Description copied from interface: CmmnRuntimeService

The local variable. Returns null when no variable value is found with the given name or when the value is set to null.

Specified by:

getLocalVariableInstance in interface CmmnRuntimeService

Parameters:

planItemInstanceId - id of plan item instance, cannot be null.

variableName - name of variable, cannot be null.

Returns:

the variable or null if the variable is undefined.

hasVariable

public boolean hasVariable(String caseInstanceId,
                           String variableName)

Description copied from interface: CmmnRuntimeService

Check whether or not this case instance has variable set with the given name, Searching for the variable is done in all scopes that are visible to the given case instance.

Specified by:

hasVariable in interface CmmnRuntimeService

setVariable

public void setVariable(String caseInstanceId,
                        String variableName,
                        Object variableValue)

Specified by:

setVariable in interface CmmnRuntimeService

setVariables

public void setVariables(String caseInstanceId,
                         Map<String,Object> variables)

Specified by:

setVariables in interface CmmnRuntimeService

setLocalVariable

public void setLocalVariable(String planItemInstanceId,
                             String variableName,
                             Object variableValue)

Specified by:

setLocalVariable in interface CmmnRuntimeService

setLocalVariables

public void setLocalVariables(String planItemInstanceId,
                              Map<String,Object> variables)

Specified by:

setLocalVariables in interface CmmnRuntimeService

removeVariable

public void removeVariable(String caseInstanceId,
                           String variableName)

Specified by:

removeVariable in interface CmmnRuntimeService

removeVariables

public void removeVariables(String caseInstanceId,
                            Collection<String> variableNames)

Specified by:

removeVariables in interface CmmnRuntimeService

removeLocalVariable

public void removeLocalVariable(String planItemInstanceId,
                                String variableName)

Specified by:

removeLocalVariable in interface CmmnRuntimeService

removeLocalVariables

public void removeLocalVariables(String planItemInstanceId,
                                 Collection<String> variableNames)

Specified by:

removeLocalVariables in interface CmmnRuntimeService

setCaseInstanceName

public void setCaseInstanceName(String caseInstanceId,
                                String caseName)

Description copied from interface: CmmnRuntimeService

Set or change the name of the case instance.

Specified by:

setCaseInstanceName in interface CmmnRuntimeService

Parameters:

caseInstanceId - the id of the case to set the name

caseName - the name to be set on the case

createCaseInstanceQuery

public CaseInstanceQuery createCaseInstanceQuery()

Specified by:

createCaseInstanceQuery in interface CmmnRuntimeService

createPlanItemInstanceQuery

public PlanItemInstanceQuery createPlanItemInstanceQuery()

Specified by:

createPlanItemInstanceQuery in interface CmmnRuntimeService

createMilestoneInstanceQuery

public MilestoneInstanceQuery createMilestoneInstanceQuery()

Specified by:

createMilestoneInstanceQuery in interface CmmnRuntimeService

createGenericEventListenerInstanceQuery

public GenericEventListenerInstanceQuery createGenericEventListenerInstanceQuery()

Specified by:

createGenericEventListenerInstanceQuery in interface CmmnRuntimeService

createSignalEventListenerInstanceQuery

public SignalEventListenerInstanceQuery createSignalEventListenerInstanceQuery()

Specified by:

createSignalEventListenerInstanceQuery in interface CmmnRuntimeService

createUserEventListenerInstanceQuery

public UserEventListenerInstanceQuery createUserEventListenerInstanceQuery()

Specified by:

createUserEventListenerInstanceQuery in interface CmmnRuntimeService

createEventSubscriptionQuery

public EventSubscriptionQuery createEventSubscriptionQuery()

Description copied from interface: CmmnRuntimeService

Creates a new EventSubscriptionQuery instance, that can be used to query the event subscriptions.

Specified by:

createEventSubscriptionQuery in interface CmmnRuntimeService

getStageOverview

public List<StageResponse> getStageOverview(String caseInstanceId)

Description copied from interface: CmmnRuntimeService

Gives back a stage overview of the case instance which includes the stage information of the case model.

Specified by:

getStageOverview in interface CmmnRuntimeService

Parameters:

caseInstanceId - id of the case instance, cannot be null.

Returns:

list of stage info objects

addUserIdentityLink

public void addUserIdentityLink(String caseInstanceId,
                                String userId,
                                String identityLinkType)

Description copied from interface: CmmnRuntimeService

Involves a user with a case instance. The type of identity link is defined by the given identityLinkType.

Specified by:

addUserIdentityLink in interface CmmnRuntimeService

Parameters:

caseInstanceId - id of the case instance, cannot be null.

userId - id of the user involve, cannot be null.

identityLinkType - type of identityLink, cannot be null.

addGroupIdentityLink

public void addGroupIdentityLink(String caseInstanceId,
                                 String groupId,
                                 String identityLinkType)

Description copied from interface: CmmnRuntimeService

Involves a group with a case instance. The type of identityLink is defined by the given identityLink.

Specified by:

addGroupIdentityLink in interface CmmnRuntimeService

Parameters:

caseInstanceId - id of the case instance, cannot be null.

groupId - id of the group to involve, cannot be null.

identityLinkType - type of identity, cannot be null.

deleteUserIdentityLink

public void deleteUserIdentityLink(String caseInstanceId,
                                   String userId,
                                   String identityLinkType)

Description copied from interface: CmmnRuntimeService

Removes the association between a user and a process instance for the given identityLinkType.

Specified by:

deleteUserIdentityLink in interface CmmnRuntimeService

Parameters:

caseInstanceId - id of the case instance, cannot be null.

userId - id of the user involve, cannot be null.

identityLinkType - type of identityLink, cannot be null.

deleteGroupIdentityLink

public void deleteGroupIdentityLink(String caseInstanceId,
                                    String groupId,
                                    String identityLinkType)

Description copied from interface: CmmnRuntimeService

Removes the association between a group and a process instance for the given identityLinkType.

Specified by:

deleteGroupIdentityLink in interface CmmnRuntimeService

Parameters:

caseInstanceId - id of the case instance, cannot be null.

groupId - id of the group to involve, cannot be null.

identityLinkType - type of identity, cannot be null.

getIdentityLinksForCaseInstance

public List<IdentityLink> getIdentityLinksForCaseInstance(String caseInstanceId)

Description copied from interface: CmmnRuntimeService

Retrieves the IdentityLinks associated with the given case instance. Such an identity link informs how a certain user is involved with a case instance.

Specified by:

getIdentityLinksForCaseInstance in interface CmmnRuntimeService

getIdentityLinksForPlanItemInstance

public List<IdentityLink> getIdentityLinksForPlanItemInstance(String planItemInstanceId)

Description copied from interface: CmmnRuntimeService

Retrieves the IdentityLinks associated with the given plan item instance. Such an identity link informs how a certain user is involved with a plan item instance.

Specified by:

getIdentityLinksForPlanItemInstance in interface CmmnRuntimeService

getEntityLinkChildrenForCaseInstance

public List<EntityLink> getEntityLinkChildrenForCaseInstance(String caseInstanceId)

Description copied from interface: CmmnRuntimeService

Retrieves the EntityLinks associated with the given case instance.

Specified by:

getEntityLinkChildrenForCaseInstance in interface CmmnRuntimeService

getEntityLinkChildrenWithSameRootAsCaseInstance

public List<EntityLink> getEntityLinkChildrenWithSameRootAsCaseInstance(String instanceId)

Description copied from interface: CmmnRuntimeService

Retrieves all the EntityLinks associated with the same root as the given case instance.

Specified by:

getEntityLinkChildrenWithSameRootAsCaseInstance in interface CmmnRuntimeService

getEntityLinkParentsForCaseInstance

public List<EntityLink> getEntityLinkParentsForCaseInstance(String caseInstanceId)

Description copied from interface: CmmnRuntimeService

Retrieves the EntityLinks where the given case instance is referenced.

Specified by:

getEntityLinkParentsForCaseInstance in interface CmmnRuntimeService

createChangePlanItemStateBuilder

public ChangePlanItemStateBuilder createChangePlanItemStateBuilder()

Description copied from interface: CmmnRuntimeService

Create a ChangePlanItemStateBuilder, that allows to set various options for changing the state of a process instance.

Specified by:

createChangePlanItemStateBuilder in interface CmmnRuntimeService

updateBusinessKey

public void updateBusinessKey(String caseInstanceId,
                              String businessKey)

Description copied from interface: CmmnRuntimeService

Updates the business key for the provided case instance

Specified by:

updateBusinessKey in interface CmmnRuntimeService

Parameters:

caseInstanceId - id of the case instance to set the business key, cannot be null

businessKey - new businessKey value

changePlanItemState

public void changePlanItemState(ChangePlanItemStateBuilderImpl changePlanItemStateBuilder)