com.edorasware.cmmn.engine.core

Class DefaultCmmnService

java.lang.Object

com.edorasware.cmmn.engine.core.DefaultCmmnService

All Implemented Interfaces:

CmmnService, LowLevelStateModelUpdater, StateModelInspector, StateModelUpdater, SynchronizedLowLevelCmmnService

public class DefaultCmmnService
extends Object
implements SynchronizedLowLevelCmmnService

A synchronized CMMN API service implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface com.edorasware.cmmn.engine.core.LowLevelStateModelUpdater

LowLevelStateModelUpdater.RecursionControl

Constructor Summary

Constructors

Constructor and Description
DefaultCmmnService(Synchronizer synchronizer, CmmnEngine cmmnEngine, StateModelCache stateModelCache)

Method Summary

Modifier and Type	Method and Description
List<AvailableAction>	getAvailableActions(String caseClientId, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) Get the list of available actions for the case identified by the passed caseClientId.
List<CaseFileItem>	getCaseFileItemInstances(String caseClientId, String definitionType, TransitionData transitionData, PersistenceListeners persistenceListeners) Query the static CMMN model of the case identified by the passed case client Id and return the list of configured case file items.
CasePlanModel	getCasePlanModel(String caseClientId, TransitionData transitionData, PersistenceListeners persistenceListeners) Get the plan item representing the case’s Case Plan Model.
List<CurrentState>	getCurrentStates(String caseClientId, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) Get the list of current states for the case identified by the passed caseClientId.
PlanItemView	getPlanItem(String caseClientId, String planItemId, TransitionData transitionData, PersistenceListeners persistenceListeners, EvaluationListeners evaluationListeners, ViewCreators viewCreators) Query a runtime case model and return a view on a particular plan item.
PlanItem	getPlanItemInstance(String caseClientId, String planItemId, TransitionData transitionData, PersistenceListeners persistenceListeners) Query a runtime case model and return a particular plan item instance.
List<PlanItem>	getPlanItemInstances(String caseClientId, Class<? extends PlanItem> planItemType, boolean singleInstanceMode, TransitionData transitionData, PersistenceListeners persistenceListeners) Query a runtime case model and return all plan item instances of a certain type.
List<PlanItem>	getPlanItemInstances(String caseClientId, Class<? extends PlanItem> planItemType, TransitionData transitionData, PersistenceListeners persistenceListeners) Calls StateModelInspector.getPlanItemInstances(String, Class, boolean, TransitionData, PersistenceListeners), passing false for singleInstanceMode parameter.
List<Map<String,Object>>	getPlanItemProperties(String caseClientId, Class<? extends PlanItem> planItemType, boolean singleInstanceMode, String[] properties, TransitionData transitionData, PersistenceListeners persistenceListeners, EvaluationListeners evaluationListeners) Query a runtime case model and return information about plan item instances of a certain type.
Map<String,Object>	getPlanItemProperties(String caseClientId, String planItemId, String[] properties, TransitionData transitionData, PersistenceListeners persistenceListeners, EvaluationListeners evaluationListeners) Query a runtime case model and return information about the selected plan item.
List<PlanItemView>	getPlanItems(String caseClientId, Class<? extends PlanItem> planItemType, boolean singleInstanceMode, TransitionData transitionData, PersistenceListeners persistenceListeners, EvaluationListeners evaluationListeners, ViewCreators viewCreators) Query a runtime case model and return a list of views on plan items of a certain type.
List<PlanItemView>	getPlanItems(String caseClientId, Class<? extends PlanItem> planItemType, TransitionData transitionData, PersistenceListeners persistenceListeners, EvaluationListeners evaluationListeners, ViewCreators viewCreators) Calls StateModelInspector.getPlanItems(String, Class, boolean, TransitionData, PersistenceListeners, EvaluationListeners, ViewCreators), passing false for singleInstanceMode parameter.
void	handleCaseFileItemTransition(String caseClientId, String caseFileItemId, CaseFileItemTransition caseFileItemTransition, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) Apply a case file item transition on the specified case file item.
void	handleCaseFileItemTransition(String caseClientId, String caseFileItemId, CaseFileItemTransition caseFileItemTransition, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners, LowLevelStateModelUpdater.RecursionControl recursionControl) Same as StateModelUpdater.handleCaseFileItemTransition(String, String, com.edorasware.cmmn.model.xml.CaseFileItemTransition, com.edorasware.cmmn.model.TransitionData, EngineListeners, PersistenceListeners) but with an additional parameter recursionControl.
void	handleCaseMigration(String caseClientId, String oldCmmnXml, String newCmmnXml, Map<String,String> clientProperties, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners)
void	handleCaseMigration(String caseClientId, String oldCmmnXml, String newCmmnXml, Map<String,String> clientProperties, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners, LowLevelStateModelUpdater.RecursionControl recursionControl) Same as StateModelUpdater.handleCaseMigration(String, String, String, Map, TransitionData, EngineListeners, PersistenceListeners) but with an additional parameter recursionControl.
void	handleDiscretionaryItemPlanning(String caseClientId, String discretionaryItemId, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) Apply the planning action on the specified discretionary item.
void	handleDiscretionaryItemPlanning(String caseClientId, String discretionaryItemId, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners, LowLevelStateModelUpdater.RecursionControl recursionControl) Same as StateModelUpdater.handleDiscretionaryItemPlanning(String, String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners) but with an additional parameter recursionControl.
void	handlePlanItemTransition(String caseClientId, String sourcePlanItemId, PlanItemTransition planItemTransition, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) <p>Trigger a state transition in the state model.
void	handlePlanItemTransition(String caseClientId, String sourcePlanItemId, PlanItemTransition planItemTransition, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners, LowLevelStateModelUpdater.RecursionControl recursionControl) Same as StateModelUpdater.handlePlanItemTransition(String, String, com.edorasware.cmmn.model.xml.PlanItemTransition, com.edorasware.cmmn.model.TransitionData, EngineListeners, PersistenceListeners) but with an additional parameter recursionControl.
void	handleStateUpdate(String caseClientId, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) <p>Re-evaluate the state model (e.g. upon detection of an external event).
void	handleStateUpdate(String caseClientId, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners, LowLevelStateModelUpdater.RecursionControl recursionControl) Same as StateModelUpdater.handleStateUpdate(String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners) but with an additional parameter recursionControl.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCmmnService

public DefaultCmmnService(Synchronizer synchronizer,
                          CmmnEngine cmmnEngine,
                          StateModelCache stateModelCache)

Method Detail

handleStateUpdate

public void handleStateUpdate(String caseClientId,
                              TransitionData transitionData,
                              EngineListeners engineListeners,
                              PersistenceListeners persistenceListeners)
                       throws IOException,
                              JAXBException

Description copied from interface: StateModelUpdater

<p>Re-evaluate the state model (e.g. upon detection of an external event).</p>

Specified by:

handleStateUpdate in interface StateModelUpdater

Parameters:

caseClientId - identifies the case (the case ID).

transitionData - the transition data

engineListeners - a callback object allowing the state engine to trigger actions in the calling client based on results (if any) from the executed transition.

persistenceListeners - persistence callbacks.

Throws:

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

JAXBException - if there was a problem creating the state model from the XML.

handleStateUpdate

public void handleStateUpdate(String caseClientId,
                              TransitionData transitionData,
                              EngineListeners engineListeners,
                              PersistenceListeners persistenceListeners,
                              LowLevelStateModelUpdater.RecursionControl recursionControl)
                       throws IOException,
                              JAXBException

Description copied from interface: LowLevelStateModelUpdater

Same as StateModelUpdater.handleStateUpdate(String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners) but with an additional parameter recursionControl.

Specified by:

handleStateUpdate in interface LowLevelStateModelUpdater

Throws:

IOException

JAXBException

handlePlanItemTransition

public void handlePlanItemTransition(String caseClientId,
                                     String sourcePlanItemId,
                                     PlanItemTransition planItemTransition,
                                     TransitionData transitionData,
                                     EngineListeners engineListeners,
                                     PersistenceListeners persistenceListeners)
                              throws IOException,
                                     JAXBException

Description copied from interface: StateModelUpdater

<p>Trigger a state transition in the state model.</p>

Specified by:

handlePlanItemTransition in interface StateModelUpdater

Parameters:

caseClientId - identifies the case (the case ID).

sourcePlanItemId - identifies the plan item upon which to apply the transition.

planItemTransition - the transition to be applied.

transitionData - the transition data

engineListeners - a callback object allowing the state engine to trigger actions in the calling client based on results (if any) from the executed transition.

persistenceListeners - persistence callbacks.

Throws:

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

JAXBException - if there was a problem creating the state model from the XML.

handlePlanItemTransition

public void handlePlanItemTransition(String caseClientId,
                                     String sourcePlanItemId,
                                     PlanItemTransition planItemTransition,
                                     TransitionData transitionData,
                                     EngineListeners engineListeners,
                                     PersistenceListeners persistenceListeners,
                                     LowLevelStateModelUpdater.RecursionControl recursionControl)
                              throws IOException,
                                     JAXBException

Description copied from interface: LowLevelStateModelUpdater

Same as StateModelUpdater.handlePlanItemTransition(String, String, com.edorasware.cmmn.model.xml.PlanItemTransition, com.edorasware.cmmn.model.TransitionData, EngineListeners, PersistenceListeners) but with an additional parameter recursionControl.

Specified by:

handlePlanItemTransition in interface LowLevelStateModelUpdater

Throws:

IOException

JAXBException

handleCaseFileItemTransition

public void handleCaseFileItemTransition(String caseClientId,
                                         String caseFileItemId,
                                         CaseFileItemTransition caseFileItemTransition,
                                         TransitionData transitionData,
                                         EngineListeners engineListeners,
                                         PersistenceListeners persistenceListeners)
                                  throws IOException,
                                         JAXBException

Description copied from interface: StateModelUpdater

Apply a case file item transition on the specified case file item.

Specified by:

handleCaseFileItemTransition in interface StateModelUpdater

Parameters:

caseClientId - identifies the case (the case ID).

caseFileItemId - identifies the case file item upon which to apply the transition.

caseFileItemTransition - the transition to be applied.

transitionData - the transition data

engineListeners - a callback object allowing the state engine to trigger actions in the calling client based on results (if any) from the executed transition.

persistenceListeners - persistence callbacks.

Throws:

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

JAXBException - if there was a problem creating the state model from the XML.

handleCaseFileItemTransition

public void handleCaseFileItemTransition(String caseClientId,
                                         String caseFileItemId,
                                         CaseFileItemTransition caseFileItemTransition,
                                         TransitionData transitionData,
                                         EngineListeners engineListeners,
                                         PersistenceListeners persistenceListeners,
                                         LowLevelStateModelUpdater.RecursionControl recursionControl)
                                  throws IOException,
                                         JAXBException

Description copied from interface: LowLevelStateModelUpdater

Same as StateModelUpdater.handleCaseFileItemTransition(String, String, com.edorasware.cmmn.model.xml.CaseFileItemTransition, com.edorasware.cmmn.model.TransitionData, EngineListeners, PersistenceListeners) but with an additional parameter recursionControl.

Specified by:

handleCaseFileItemTransition in interface LowLevelStateModelUpdater

Throws:

IOException

JAXBException

handleDiscretionaryItemPlanning

public void handleDiscretionaryItemPlanning(String caseClientId,
                                            String discretionaryItemId,
                                            TransitionData transitionData,
                                            EngineListeners engineListeners,
                                            PersistenceListeners persistenceListeners)
                                     throws IOException,
                                            JAXBException

Description copied from interface: StateModelUpdater

Apply the planning action on the specified discretionary item.

Specified by:

handleDiscretionaryItemPlanning in interface StateModelUpdater

Parameters:

caseClientId - identifies the case (the case ID).

discretionaryItemId - identifies the target item of the planning action.

transitionData - the transition data

engineListeners - a callback object allowing the state engine to trigger actions in the calling client based on results (if any) from the executed transition.

persistenceListeners - persistence callbacks.

Throws:

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

JAXBException - if there was a problem creating the state model from the XML.

handleDiscretionaryItemPlanning

public void handleDiscretionaryItemPlanning(String caseClientId,
                                            String discretionaryItemId,
                                            TransitionData transitionData,
                                            EngineListeners engineListeners,
                                            PersistenceListeners persistenceListeners,
                                            LowLevelStateModelUpdater.RecursionControl recursionControl)
                                     throws IOException,
                                            JAXBException

Description copied from interface: LowLevelStateModelUpdater

Same as StateModelUpdater.handleDiscretionaryItemPlanning(String, String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners) but with an additional parameter recursionControl.

Specified by:

handleDiscretionaryItemPlanning in interface LowLevelStateModelUpdater

Throws:

IOException

JAXBException

handleCaseMigration

public void handleCaseMigration(String caseClientId,
                                String oldCmmnXml,
                                String newCmmnXml,
                                Map<String,String> clientProperties,
                                TransitionData transitionData,
                                EngineListeners engineListeners,
                                PersistenceListeners persistenceListeners)
                         throws IOException,
                                JAXBException

Specified by:

handleCaseMigration in interface StateModelUpdater

Parameters:

caseClientId - identifies the case (the case ID).

oldCmmnXml - the CMMN model definition the current run-time state is based on.

newCmmnXml - the CMMN model definition the current run-time state is to be migrated to.

clientProperties - a map of properties passed in by the caller. This map is passed along in the call-backs of the MigrationListeners interface.

transitionData - the transition data

engineListeners - a callback object allowing the state engine to trigger actions in the calling client based on results (if any) from the executed transition.

persistenceListeners - persistence callbacks.

Throws:

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

JAXBException - if there was a problem creating the state model from the XML.

handleCaseMigration

public void handleCaseMigration(String caseClientId,
                                String oldCmmnXml,
                                String newCmmnXml,
                                Map<String,String> clientProperties,
                                TransitionData transitionData,
                                EngineListeners engineListeners,
                                PersistenceListeners persistenceListeners,
                                LowLevelStateModelUpdater.RecursionControl recursionControl)
                         throws IOException,
                                JAXBException

Description copied from interface: LowLevelStateModelUpdater

Same as StateModelUpdater.handleCaseMigration(String, String, String, Map, TransitionData, EngineListeners, PersistenceListeners) but with an additional parameter recursionControl.

Specified by:

handleCaseMigration in interface LowLevelStateModelUpdater

Throws:

IOException

JAXBException

getCurrentStates

public List<CurrentState> getCurrentStates(String caseClientId,
                                           TransitionData transitionData,
                                           EngineListeners engineListeners,
                                           PersistenceListeners persistenceListeners)
                                    throws JAXBException,
                                           IOException

Description copied from interface: StateModelInspector

Get the list of current states for the case identified by the passed caseClientId.

Specified by:

getCurrentStates in interface StateModelInspector

Parameters:

caseClientId - identifies the case (the case ID).

transitionData - optional evaluation context. Parameters passed here will be available for evaluation in run-time expressions.

engineListeners - a callback object allowing the state engine to trigger actions in the calling client based on results (if any) from the executed transition.

persistenceListeners - persistence callbacks.

Returns:

the list of current states for the given case.

Throws:

JAXBException - if there was a problem creating the state model from the XML.

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

getAvailableActions

public List<AvailableAction> getAvailableActions(String caseClientId,
                                                 TransitionData transitionData,
                                                 EngineListeners engineListeners,
                                                 PersistenceListeners persistenceListeners)
                                          throws JAXBException,
                                                 IOException

Description copied from interface: StateModelInspector

Get the list of available actions for the case identified by the passed caseClientId.

Specified by:

getAvailableActions in interface StateModelInspector

Parameters:

caseClientId - identifies the case (the case ID).

transitionData - optional evaluation context. Parameters passed here will be available for evaluation in run-time expressions.

engineListeners - a callback object allowing the state engine to trigger actions in the calling client based on results (if any) from the executed transition.

persistenceListeners - persistence callbacks.

Returns:

the list of available actions for the given case.

Throws:

JAXBException - if there was a problem creating the state model from the XML.

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

getPlanItemProperties

public Map<String,Object> getPlanItemProperties(String caseClientId,
                                                String planItemId,
                                                String[] properties,
                                                TransitionData transitionData,
                                                PersistenceListeners persistenceListeners,
                                                EvaluationListeners evaluationListeners)
                                         throws JAXBException,
                                                IOException

Description copied from interface: StateModelInspector

Query a runtime case model and return information about the selected plan item. The information collected and returned is specified via the properties parameter. The result of the method is a map representing the plan item instance. The map elements to be populated are specified via the properties parameter. Each property listed will be available in the result map as a key/value pair. The properties are resolved via reflection against a DefaultPlanItemView.

Specified by:

getPlanItemProperties in interface StateModelInspector

Parameters:

caseClientId - identifies the case (the case ID).

planItemId - the plan item Id - model Id, instance Id, client Id or client reference (will match in this order). In case of ambiguity, selects the highest instance Id for the selected model element.

properties - the list of bean properties to get.

transitionData - optional evaluation context. Parameters passed here will be available for evaluation in run-time expressions.

persistenceListeners - persistence callbacks.

Returns:

the selected plan item properties.

Throws:

JAXBException - if there was a problem creating the state model from the XML.

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

getPlanItemProperties

public List<Map<String,Object>> getPlanItemProperties(String caseClientId,
                                                      Class<? extends PlanItem> planItemType,
                                                      boolean singleInstanceMode,
                                                      String[] properties,
                                                      TransitionData transitionData,
                                                      PersistenceListeners persistenceListeners,
                                                      EvaluationListeners evaluationListeners)
                                               throws JAXBException,
                                                      IOException

Description copied from interface: StateModelInspector

Query a runtime case model and return information about plan item instances of a certain type. The information collected and returned is specified via the properties parameter. The result of the method is a list of maps. Each map represents a plan item instance. The map elements to be populated are specified via the properties parameter. Each property listed will be available in the respective result map as a key/value pair. The properties are resolved via reflection against a DefaultPlanItemView for each selected plan item. Make sure to include a suitable id property in your properties list to make sure that you can clearly associate the returned maps to plan item instances.

Specified by:

getPlanItemProperties in interface StateModelInspector

Parameters:

caseClientId - identifies the case (the case ID).

planItemType - the type of plan item to collect. Honors class hierarchy, i.e. you can pass any super-class type to get all plan item instances of the super-class type and any sub-types.

singleInstanceMode - pass true to only select one instance per model plan item (selects the one with the highest instance Id).

properties - the list of bean properties to get.

transitionData - optional evaluation context. Parameters passed here will be available for evaluation in run-time expressions.

persistenceListeners - persistence callbacks.

Returns:

the list of plan item instances that are assignable to planItemType.

Throws:

JAXBException - if there was a problem creating the state model from the XML.

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

getPlanItem

public PlanItemView getPlanItem(String caseClientId,
                                String planItemId,
                                TransitionData transitionData,
                                PersistenceListeners persistenceListeners,
                                EvaluationListeners evaluationListeners,
                                ViewCreators viewCreators)
                         throws JAXBException,
                                IOException

Description copied from interface: StateModelInspector

Query a runtime case model and return a view on a particular plan item.

Specified by:

getPlanItem in interface StateModelInspector

Parameters:

caseClientId - identifies the case (the case ID).

planItemId - the plan item Id - model Id, instance Id, client Id or client reference (will match in this order). In case of ambiguity, selects the highest instance Id for the selected model element.

transitionData - optional evaluation context. Parameters passed here will be available for evaluation in run-time expressions.

persistenceListeners - persistence callbacks.

viewCreators - view creator callbacks.

Returns:

the plan item view for the given planItemId.

Throws:

JAXBException - if there was a problem creating the state model from the XML.

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

getPlanItems

public List<PlanItemView> getPlanItems(String caseClientId,
                                       Class<? extends PlanItem> planItemType,
                                       TransitionData transitionData,
                                       PersistenceListeners persistenceListeners,
                                       EvaluationListeners evaluationListeners,
                                       ViewCreators viewCreators)
                                throws JAXBException,
                                       IOException

Description copied from interface: StateModelInspector

Calls StateModelInspector.getPlanItems(String, Class, boolean, TransitionData, PersistenceListeners, EvaluationListeners, ViewCreators), passing false for singleInstanceMode parameter.

Specified by:

getPlanItems in interface StateModelInspector

Throws:

JAXBException

IOException

getPlanItems

public List<PlanItemView> getPlanItems(String caseClientId,
                                       Class<? extends PlanItem> planItemType,
                                       boolean singleInstanceMode,
                                       TransitionData transitionData,
                                       PersistenceListeners persistenceListeners,
                                       EvaluationListeners evaluationListeners,
                                       ViewCreators viewCreators)
                                throws JAXBException,
                                       IOException

Description copied from interface: StateModelInspector

Query a runtime case model and return a list of views on plan items of a certain type.

Specified by:

getPlanItems in interface StateModelInspector

Parameters:

caseClientId - identifies the case (the case ID).

planItemType - the type of plan item to collect. Honors class hierarchy, i.e. you can pass any super-class type to get all plan item instances of the super-class type and any sub-types.

singleInstanceMode - pass true to only select one instance per model plan item (selects the one with the highest instance Id).

transitionData - optional evaluation context. Parameters passed here will be available for evaluation in run-time expressions.

persistenceListeners - persistence callbacks.

viewCreators - view creator callbacks.

Returns:

the list of plan item views that are assignable to planItemType.

Throws:

JAXBException - if there was a problem creating the state model from the XML.

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

getPlanItemInstance

public PlanItem getPlanItemInstance(String caseClientId,
                                    String planItemId,
                                    TransitionData transitionData,
                                    PersistenceListeners persistenceListeners)
                             throws JAXBException,
                                    IOException

Description copied from interface: StateModelInspector

Query a runtime case model and return a particular plan item instance.

Specified by:

getPlanItemInstance in interface StateModelInspector

Parameters:

caseClientId - identifies the case (the case ID).

planItemId - the plan item Id - model Id, instance Id, client Id or client reference (will match in this order). In case of ambiguity, selects the highest instance Id for the selected model element.

transitionData - optional evaluation context. Parameters passed here will be available for evaluation in run-time expressions.

persistenceListeners - persistence callbacks.

Returns:

the plan item for the given planItemId.

Throws:

JAXBException - if there was a problem creating the state model from the XML.

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

getPlanItemInstances

public List<PlanItem> getPlanItemInstances(String caseClientId,
                                           Class<? extends PlanItem> planItemType,
                                           TransitionData transitionData,
                                           PersistenceListeners persistenceListeners)
                                    throws JAXBException,
                                           IOException

Description copied from interface: StateModelInspector

Calls StateModelInspector.getPlanItemInstances(String, Class, boolean, TransitionData, PersistenceListeners), passing false for singleInstanceMode parameter.

Specified by:

getPlanItemInstances in interface StateModelInspector

Throws:

JAXBException

IOException

getPlanItemInstances

public List<PlanItem> getPlanItemInstances(String caseClientId,
                                           Class<? extends PlanItem> planItemType,
                                           boolean singleInstanceMode,
                                           TransitionData transitionData,
                                           PersistenceListeners persistenceListeners)
                                    throws JAXBException,
                                           IOException

Description copied from interface: StateModelInspector

Query a runtime case model and return all plan item instances of a certain type.

Specified by:

getPlanItemInstances in interface StateModelInspector

Parameters:

caseClientId - identifies the case (the case ID).

planItemType - the type of plan item to collect. Honors class hierarchy, i.e. you can pass any super-class type to get all plan item instances of the super-class type and any sub-types.

singleInstanceMode - pass true to only select one instance per model plan item (selects the one with the highest instance Id).

transitionData - optional evaluation context. Parameters passed here will be available for evaluation in run-time expressions.

persistenceListeners - persistence callbacks.

Returns:

the list of plan item instances that are assignable to planItemType.

Throws:

JAXBException - if there was a problem creating the state model from the XML.

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

getCasePlanModel

public CasePlanModel getCasePlanModel(String caseClientId,
                                      TransitionData transitionData,
                                      PersistenceListeners persistenceListeners)
                               throws JAXBException,
                                      IOException

Description copied from interface: StateModelInspector

Get the plan item representing the case’s Case Plan Model.

Specified by:

getCasePlanModel in interface StateModelInspector

Parameters:

caseClientId - identifies the case (the case ID).

transitionData - optional evaluation context. Parameters passed here will be available for evaluation in run-time expressions.

persistenceListeners - persistence callbacks.

Returns:

the Case Plan Model

Throws:

JAXBException - if there was a problem creating the state model from the XML.

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.

getCaseFileItemInstances

public List<CaseFileItem> getCaseFileItemInstances(String caseClientId,
                                                   String definitionType,
                                                   TransitionData transitionData,
                                                   PersistenceListeners persistenceListeners)
                                            throws JAXBException,
                                                   IOException

Description copied from interface: StateModelInspector

Query the static CMMN model of the case identified by the passed case client Id and return the list of configured case file items.

Specified by:

getCaseFileItemInstances in interface StateModelInspector

Parameters:

caseClientId - identifies the case (the case ID).

definitionType - the type of case file items to return. Passing null returns any type.

transitionData - optional evaluation context. Parameters passed here will be available for evaluation in run-time expressions.

persistenceListeners - persistence callbacks.

Returns:

the list of model case file items of the given type or all case file items (if no definition type is specified).

Throws:

JAXBException - if there was a problem creating the state model from the XML.

IOException - if there was a problem creating the state model from the XML or if the initial state of the newly created state model could not be persisted.