com.edorasware.cmmn.engine.core

Interface StateModelManager

All Known Subinterfaces:

CmmnEngine

All Known Implementing Classes:

DefaultCmmnEngine

public interface StateModelManager

Exposes API to create state models and access state model instances.

Method Summary

Modifier and Type	Method and Description
StateModel	createStateModel(String caseClientId, String parentCaseId, Map<String,String> clientProperties, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners) Create a particular state model for a new case.
StateModel	getStateModel(String caseClientId, Map<String,String> clientProperties, PersistenceListeners persistenceListeners) Restore a state model either from cache or, if not in the cache, from the original case XML and the stored (persisted) runtime state of the case.

Method Detail

createStateModel

StateModel createStateModel(String caseClientId,
                            String parentCaseId,
                            Map<String,String> clientProperties,
                            TransitionData transitionData,
                            EngineListeners engineListeners,
                            PersistenceListeners persistenceListeners)
                     throws JAXBException,
                            IOException

Create a particular state model for a new case.

Parameters:

caseClientId - the client ID for the case.

parentCaseId - the ID of the parent case. This applies only to cases created as a result of a CaseTask.

clientProperties - the client properties

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.

Returns:

the state model created.

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.

getStateModel

StateModel getStateModel(String caseClientId,
                         Map<String,String> clientProperties,
                         PersistenceListeners persistenceListeners)
                  throws JAXBException,
                         IOException

Restore a state model either from cache or, if not in the cache, from the original case XML and the stored (persisted) runtime state of the case.

Parameters:

caseClientId - the case client ID.

persistenceListeners - persistence callbacks.

Returns:

the state model

Throws:

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

IOException - if there was a problem creating the state model from the XML or from the saved case state.