com.edorasware.cmmn.engine.core

Interface StateModelUpdater

All Known Subinterfaces:

CmmnService, SynchronizedLowLevelCmmnService

All Known Implementing Classes:

DefaultCmmnService

public interface StateModelUpdater

High-level API to invoke state updates and state transitions.

Method Summary

Modifier and Type	Method and Description
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	handleCaseMigration(String caseClientId, String oldCmmnXml, String newCmmnXml, Map<String,String> clientProperties, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners)
void	handleDiscretionaryItemPlanning(String caseClientId, String discretionaryItemId, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) Apply the planning action on the specified discretionary item.
void	handlePlanItemTransition(String caseClientId, String sourcePlanItemId, PlanItemTransition planItemTransition, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) <p>Trigger a state transition in the state model.
void	handleStateUpdate(String caseClientId, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) <p>Re-evaluate the state model (e.g. upon detection of an external event).

Method Detail

handleStateUpdate

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

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

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:

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.

handlePlanItemTransition

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

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

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:

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.

handleCaseFileItemTransition

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

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

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:

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.

handleDiscretionaryItemPlanning

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

Apply the planning action on the specified discretionary item.

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:

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.

handleCaseMigration

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

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:

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.