com.edorasware.cmmn.engine.core

Interface StateModelInspector

All Known Subinterfaces:

CmmnEngine, CmmnService, SynchronizedLowLevelCmmnService

All Known Implementing Classes:

DefaultCmmnEngine, DefaultCmmnService

public interface StateModelInspector

High-level API to query state models.

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 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 getPlanItems(String, Class, boolean, TransitionData, PersistenceListeners, EvaluationListeners, ViewCreators), passing false for singleInstanceMode parameter.

Method Detail

getCurrentStates

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

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

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.

IllegalStateException - if there is a synchronization problem (calls to this method must be externally serialized for the given case).

getAvailableActions

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

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

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.

IllegalStateException - if there is a synchronization problem (calls to this method must be externally serialized for the given case).

getPlanItem

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

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

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:

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.

IllegalStateException - if there is a synchronization problem (calls to this method must be externally serialized for the given case).

getPlanItems

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

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

Throws:

JAXBException

IOException

getPlanItems

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

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

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:

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.

IllegalStateException - if there is a synchronization problem (calls to this method must be externally serialized for the given case).

getPlanItemProperties

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

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.

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:

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.

IllegalStateException - if there is a synchronization problem (calls to this method must be externally serialized for the given case).

getPlanItemProperties

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

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.

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:

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.

IllegalStateException - if there is a synchronization problem (calls to this method must be externally serialized for the given case).

getPlanItemInstance

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

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

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:

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.

IllegalStateException - if there is a synchronization problem (calls to this method must be externally serialized for the given case).

getPlanItemInstances

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

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

Throws:

JAXBException

IOException

getPlanItemInstances

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

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

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:

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.

IllegalStateException - if there is a synchronization problem (calls to this method must be externally serialized for the given case).

getCasePlanModel

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

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

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:

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.

IllegalStateException - if there is a synchronization problem (calls to this method must be externally serialized for the given case).

getCaseFileItemInstances

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

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

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:

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.