org.flowable.cmmn.api

Interface CmmnRuntimeService

public interface CmmnRuntimeService

Author:

Joram Barrez

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	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	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 instanceId) Retrieves the EntityLinks associated with the given case instance.
List<EntityLink>	getEntityLinkParentsForCaseInstance(String instanceId) Retrieves the EntityLinks where the given case instance is referenced.
List<org.flowable.identitylink.api.IdentityLink>	getIdentityLinksForCaseInstance(String instanceId) Retrieves the IdentityLinks associated with the given case instance.
Object	getLocalVariable(String planItemInstanceId, String variableName)
Map<String,Object>	getLocalVariables(String planItemInstanceId)
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)
Map<String,Object>	getVariables(String caseInstanceId)
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)
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

Method Detail

createCaseInstanceBuilder

CaseInstanceBuilder createCaseInstanceBuilder()

createPlanItemInstanceTransitionBuilder

PlanItemInstanceTransitionBuilder createPlanItemInstanceTransitionBuilder(String planItemInstanceId)

triggerPlanItemInstance

void triggerPlanItemInstance(String planItemInstanceId)

enablePlanItemInstance

void enablePlanItemInstance(String planItemInstanceId)

startPlanItemInstance

void startPlanItemInstance(String planItemInstanceId)

disablePlanItemInstance

void disablePlanItemInstance(String planItemInstanceId)

completeStagePlanItemInstance

void completeStagePlanItemInstance(String planItemInstanceId)

completeStagePlanItemInstance

void completeStagePlanItemInstance(String planItemInstanceId,
                                   boolean force)

completeCaseInstance

void completeCaseInstance(String caseInstanceId)

terminateCaseInstance

void terminateCaseInstance(String caseInstanceId)

terminatePlanItemInstance

void terminatePlanItemInstance(String planItemInstanceId)

evaluateCriteria

void evaluateCriteria(String caseInstanceId)

completeGenericEventListenerInstance

void completeGenericEventListenerInstance(String genericEventListenerInstanceId)

completeUserEventListenerInstance

void completeUserEventListenerInstance(String userEventListenerInstanceId)

getVariables

Map<String,Object> getVariables(String caseInstanceId)

getLocalVariables

Map<String,Object> getLocalVariables(String planItemInstanceId)

getVariable

Object getVariable(String caseInstanceId,
                   String variableName)

getLocalVariable

Object getLocalVariable(String planItemInstanceId,
                        String variableName)

hasVariable

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.

setVariables

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

setVariable

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

setLocalVariables

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

setLocalVariable

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

removeVariable

void removeVariable(String caseInstanceId,
                    String variableName)

removeVariables

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

removeLocalVariable

void removeLocalVariable(String planItemInstanceId,
                         String variableName)

removeLocalVariables

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

setCaseInstanceName

void setCaseInstanceName(String caseInstanceId,
                         String caseName)

Set or change the name of the case instance.

Parameters:

caseInstanceId - the id of the case to set the name

caseName - the name to be set on the case

createCaseInstanceQuery

CaseInstanceQuery createCaseInstanceQuery()

createPlanItemInstanceQuery

PlanItemInstanceQuery createPlanItemInstanceQuery()

createMilestoneInstanceQuery

MilestoneInstanceQuery createMilestoneInstanceQuery()

createGenericEventListenerInstanceQuery

GenericEventListenerInstanceQuery createGenericEventListenerInstanceQuery()

createSignalEventListenerInstanceQuery

SignalEventListenerInstanceQuery createSignalEventListenerInstanceQuery()

createUserEventListenerInstanceQuery

UserEventListenerInstanceQuery createUserEventListenerInstanceQuery()

createEventSubscriptionQuery

EventSubscriptionQuery createEventSubscriptionQuery()

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

addUserIdentityLink

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

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

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.

Throws:

FlowableObjectNotFoundException - when the process instance doesn't exist.

addGroupIdentityLink

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

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

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.

Throws:

FlowableObjectNotFoundException - when the process instance or group doesn't exist.

deleteUserIdentityLink

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

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

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.

Throws:

FlowableObjectNotFoundException - when the task or user doesn't exist.

deleteGroupIdentityLink

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

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

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.

Throws:

FlowableObjectNotFoundException - when the task or group doesn't exist.

getIdentityLinksForCaseInstance

List<org.flowable.identitylink.api.IdentityLink> getIdentityLinksForCaseInstance(String instanceId)

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

getEntityLinkChildrenForCaseInstance

List<EntityLink> getEntityLinkChildrenForCaseInstance(String instanceId)

Retrieves the EntityLinks associated with the given case instance.

getEntityLinkParentsForCaseInstance

List<EntityLink> getEntityLinkParentsForCaseInstance(String instanceId)

Retrieves the EntityLinks where the given case instance is referenced.

getStartFormModel

FormInfo getStartFormModel(String caseDefinitionId,
                           String caseInstanceId)

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

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.

createChangePlanItemStateBuilder

ChangePlanItemStateBuilder createChangePlanItemStateBuilder()

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

updateBusinessKey

void updateBusinessKey(String caseInstanceId,
                       String businessKey)

Updates the business key for the provided case instance

Parameters:

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

businessKey - new businessKey value