com.edorasware.cmmn.one.service

Interface OneCmmnService

All Known Implementing Classes:

DefaultOneCmmnService

public interface OneCmmnService

The CMMN service interface.

Method Summary

Modifier and Type	Method and Description
com.edorasware.cmmn.model.TransitionData	formData(Object... keyValues) Create a TransitionData object containing formData key/value pairs as passed in.
List<com.edorasware.cmmn.model.casefile.CaseFileItem>	getCaseFileItemInstances(String caseId, String definitionType) See getCaseFileItemInstances(String, String, TransitionData) (passing null as transitionData).
List<com.edorasware.cmmn.model.casefile.CaseFileItem>	getCaseFileItemInstances(String caseId, String definitionType, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelInspector.getCaseFileItemInstances(String, String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.PersistenceListeners)
com.edorasware.cmmn.model.structure.CasePlanModel	getCasePlanModel(String caseId) See getCasePlanModel(String, TransitionData) (passing null as transitionData).
com.edorasware.cmmn.model.structure.CasePlanModel	getCasePlanModel(String caseId, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelInspector.getCasePlanModel(String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.PersistenceListeners)
List<com.edorasware.cmmn.model.statesandactions.CurrentState>	getCurrentStates(String caseId) See getCurrentStates(String, TransitionData) (passing null as transitionData).
List<com.edorasware.cmmn.model.statesandactions.CurrentState>	getCurrentStates(String caseId, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelInspector.getCurrentStates(String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners)
com.edorasware.cmmn.model.expressions.PlanItemView	getPlanItem(String caseId, String planItemId) See getPlanItem(String, String, TransitionData) (passing null as transitionData).
com.edorasware.cmmn.model.expressions.PlanItemView	getPlanItem(String caseId, String planItemId, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelInspector.getPlanItem(String, String, TransitionData, PersistenceListeners, EvaluationListeners, ViewCreators)
com.edorasware.cmmn.model.structure.PlanItem	getPlanItemInstance(String caseId, String planItemId) See getPlanItemInstance(String, String, TransitionData) (passing null as transitionData).
com.edorasware.cmmn.model.structure.PlanItem	getPlanItemInstance(String caseId, String planItemId, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelInspector.getPlanItemInstance(String, String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.PersistenceListeners)
List<com.edorasware.cmmn.model.structure.PlanItem>	getPlanItemInstances(String caseId, Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType) See getPlanItemInstances(String, Class, boolean, TransitionData) (passing null as transitionData).
List<com.edorasware.cmmn.model.structure.PlanItem>	getPlanItemInstances(String caseId, Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType, boolean singleInstanceMode) See getPlanItemInstances(String, Class, boolean, TransitionData) (passing null as transitionData).
List<com.edorasware.cmmn.model.structure.PlanItem>	getPlanItemInstances(String caseId, Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType, boolean singleInstanceMode, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelInspector.getPlanItemInstances(String, Class, boolean, TransitionData, PersistenceListeners)
List<com.edorasware.cmmn.model.structure.PlanItem>	getPlanItemInstances(String caseId, Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelInspector.getPlanItemInstances(String, Class, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.PersistenceListeners)
List<Map<String,Object>>	getPlanItemProperties(String caseId, Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType, boolean singleInstanceMode, String[] properties) See getPlanItemProperties(String, Class, boolean, String[], TransitionData) perties(WorkObjectId, Class, boolean, String[])} (passing null as transitionData).
List<Map<String,Object>>	getPlanItemProperties(String caseId, Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType, boolean singleInstanceMode, String[] properties, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelInspector.getPlanItemProperties(String, Class, boolean, String[], TransitionData, PersistenceListeners, EvaluationListeners)
Map<String,Object>	getPlanItemProperties(String caseId, String planItemId, String[] properties) See getPlanItemProperties(String, String, String[], TransitionData) (passing null as transitionData).
Map<String,Object>	getPlanItemProperties(String caseId, String planItemId, String[] properties, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelInspector.getPlanItemProperties(String, String, String[], TransitionData, PersistenceListeners, EvaluationListeners)
List<com.edorasware.cmmn.model.expressions.PlanItemView>	getPlanItems(String caseId, Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType) See getPlanItems(String, Class, boolean, TransitionData) (passing null as transitionData).
List<com.edorasware.cmmn.model.expressions.PlanItemView>	getPlanItems(String caseId, Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType, boolean singleInstanceMode) See getPlanItems(String, Class, boolean, TransitionData) (passing null as transitionData).
List<com.edorasware.cmmn.model.expressions.PlanItemView>	getPlanItems(String caseId, Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType, boolean singleInstanceMode, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelInspector.getPlanItems(String, Class, boolean, TransitionData, PersistenceListeners, EvaluationListeners, ViewCreators)
List<com.edorasware.cmmn.model.expressions.PlanItemView>	getPlanItems(String caseId, Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelInspector.getPlanItems(String, Class, TransitionData, PersistenceListeners, EvaluationListeners, ViewCreators)
void	handleCaseFileItemTransition(String caseId, String caseFileItemId, com.edorasware.cmmn.model.xml.CaseFileItemTransition caseFileItemTransition) See handleCaseFileItemTransition(String, String, CaseFileItemTransition, TransitionData) (passing null as transitionData).
void	handleCaseFileItemTransition(String caseId, String caseFileItemId, com.edorasware.cmmn.model.xml.CaseFileItemTransition caseFileItemTransition, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelUpdater.handleCaseFileItemTransition(String, String, com.edorasware.cmmn.model.xml.CaseFileItemTransition, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners)
void	handleCaseMigration(String caseId, String oldCmmnXml, String newXmmnXml, Map<String,String> clientProperties, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelUpdater.handleCaseMigration(String, String, String, Map, TransitionData, EngineListeners, PersistenceListeners) <String, String>, TransitionData, EngineListeners, PersistenceListeners)}
void	handleDiscretionaryItemPlanning(String caseId, String discretionaryItemId) See handleDiscretionaryItemPlanning(String, String, TransitionData) (passing null as transitionData).
void	handleDiscretionaryItemPlanning(String caseId, String discretionaryItemId, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelUpdater.handleDiscretionaryItemPlanning(String, String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners)
void	handlePlanItemTransition(String caseId, String planItemId, com.edorasware.cmmn.model.xml.PlanItemTransition planItemTransition) See handlePlanItemTransition(String, String, PlanItemTransition, TransitionData) StateUpdate(WorkObjectId, TransitionData)} (passing null as transitionData).
void	handlePlanItemTransition(String caseId, String planItemId, com.edorasware.cmmn.model.xml.PlanItemTransition planItemTransition, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelUpdater.handlePlanItemTransition(String, String, com.edorasware.cmmn.model.xml.PlanItemTransition, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners)
void	handleStateUpdate(String caseId) See handleStateUpdate(String, TransitionData) (passing null as transitionData).
void	handleStateUpdate(String caseId, com.edorasware.cmmn.model.TransitionData transitionData) See StateModelUpdater.handleStateUpdate(String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners)
boolean	isCurrentUserAllowedToBrowseToWorkObject(com.edorasware.commons.core.any.AnyWorkObject workObject) Check if the current user is allowed to browse (i.e. navigate to) the passed Work Object.
com.edorasware.cmmn.model.TransitionData	parameters(Object... keyValues) Create a TransitionData object containing parameter key/value pairs as passed in.
String	resolveId(Object workObjectId) Best effort work object Id resolution.
String	resolveIdFromExternalId(Object workObjectId) Similar to resolveId(Object) with the difference that the Id passed in the input parameter is expected to be an external work object Id.

Method Detail

handleStateUpdate

void handleStateUpdate(String caseId)

See handleStateUpdate(String, TransitionData) (passing null as transitionData).

handleStateUpdate

void handleStateUpdate(String caseId,
                       com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelUpdater.handleStateUpdate(String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners)

handlePlanItemTransition

void handlePlanItemTransition(String caseId,
                              String planItemId,
                              com.edorasware.cmmn.model.xml.PlanItemTransition planItemTransition)

See handlePlanItemTransition(String, String, PlanItemTransition, TransitionData) StateUpdate(WorkObjectId, TransitionData)} (passing null as transitionData).

handlePlanItemTransition

void handlePlanItemTransition(String caseId,
                              String planItemId,
                              com.edorasware.cmmn.model.xml.PlanItemTransition planItemTransition,
                              com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelUpdater.handlePlanItemTransition(String, String, com.edorasware.cmmn.model.xml.PlanItemTransition, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners)

handleCaseFileItemTransition

void handleCaseFileItemTransition(String caseId,
                                  String caseFileItemId,
                                  com.edorasware.cmmn.model.xml.CaseFileItemTransition caseFileItemTransition)

See handleCaseFileItemTransition(String, String, CaseFileItemTransition, TransitionData) (passing null as transitionData).

handleCaseFileItemTransition

void handleCaseFileItemTransition(String caseId,
                                  String caseFileItemId,
                                  com.edorasware.cmmn.model.xml.CaseFileItemTransition caseFileItemTransition,
                                  com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelUpdater.handleCaseFileItemTransition(String, String, com.edorasware.cmmn.model.xml.CaseFileItemTransition, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners)

handleDiscretionaryItemPlanning

void handleDiscretionaryItemPlanning(String caseId,
                                     String discretionaryItemId)

See handleDiscretionaryItemPlanning(String, String, TransitionData) (passing null as transitionData).

handleDiscretionaryItemPlanning

void handleDiscretionaryItemPlanning(String caseId,
                                     String discretionaryItemId,
                                     com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelUpdater.handleDiscretionaryItemPlanning(String, String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners)

handleCaseMigration

void handleCaseMigration(String caseId,
                         String oldCmmnXml,
                         String newXmmnXml,
                         Map<String,String> clientProperties,
                         com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelUpdater.handleCaseMigration(String, String, String, Map, TransitionData, EngineListeners, PersistenceListeners) <String, String>, TransitionData, EngineListeners, PersistenceListeners)}

getCurrentStates

List<com.edorasware.cmmn.model.statesandactions.CurrentState> getCurrentStates(String caseId)

See getCurrentStates(String, TransitionData) (passing null as transitionData).

getCurrentStates

List<com.edorasware.cmmn.model.statesandactions.CurrentState> getCurrentStates(String caseId,
                                                                               com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelInspector.getCurrentStates(String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.EngineListeners, com.edorasware.cmmn.engine.hooks.PersistenceListeners)

getPlanItem

com.edorasware.cmmn.model.expressions.PlanItemView getPlanItem(String caseId,
                                                               String planItemId)

See getPlanItem(String, String, TransitionData) (passing null as transitionData).

getPlanItem

com.edorasware.cmmn.model.expressions.PlanItemView getPlanItem(String caseId,
                                                               String planItemId,
                                                               com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelInspector.getPlanItem(String, String, TransitionData, PersistenceListeners, EvaluationListeners, ViewCreators)

getPlanItems

List<com.edorasware.cmmn.model.expressions.PlanItemView> getPlanItems(String caseId,
                                                                      Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType)

See getPlanItems(String, Class, boolean, TransitionData) (passing null as transitionData).

getPlanItems

List<com.edorasware.cmmn.model.expressions.PlanItemView> getPlanItems(String caseId,
                                                                      Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType,
                                                                      com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelInspector.getPlanItems(String, Class, TransitionData, PersistenceListeners, EvaluationListeners, ViewCreators)

getPlanItems

List<com.edorasware.cmmn.model.expressions.PlanItemView> getPlanItems(String caseId,
                                                                      Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType,
                                                                      boolean singleInstanceMode)

See getPlanItems(String, Class, boolean, TransitionData) (passing null as transitionData).

getPlanItems

List<com.edorasware.cmmn.model.expressions.PlanItemView> getPlanItems(String caseId,
                                                                      Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType,
                                                                      boolean singleInstanceMode,
                                                                      com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelInspector.getPlanItems(String, Class, boolean, TransitionData, PersistenceListeners, EvaluationListeners, ViewCreators)

getCasePlanModel

com.edorasware.cmmn.model.structure.CasePlanModel getCasePlanModel(String caseId)

See getCasePlanModel(String, TransitionData) (passing null as transitionData).

getCasePlanModel

com.edorasware.cmmn.model.structure.CasePlanModel getCasePlanModel(String caseId,
                                                                   com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelInspector.getCasePlanModel(String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.PersistenceListeners)

getPlanItemInstance

com.edorasware.cmmn.model.structure.PlanItem getPlanItemInstance(String caseId,
                                                                 String planItemId)

See getPlanItemInstance(String, String, TransitionData) (passing null as transitionData).

getPlanItemInstance

com.edorasware.cmmn.model.structure.PlanItem getPlanItemInstance(String caseId,
                                                                 String planItemId,
                                                                 com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelInspector.getPlanItemInstance(String, String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.PersistenceListeners)

getPlanItemInstances

List<com.edorasware.cmmn.model.structure.PlanItem> getPlanItemInstances(String caseId,
                                                                        Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType)

See getPlanItemInstances(String, Class, boolean, TransitionData) (passing null as transitionData).

getPlanItemInstances

List<com.edorasware.cmmn.model.structure.PlanItem> getPlanItemInstances(String caseId,
                                                                        Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType,
                                                                        com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelInspector.getPlanItemInstances(String, Class, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.PersistenceListeners)

getPlanItemInstances

List<com.edorasware.cmmn.model.structure.PlanItem> getPlanItemInstances(String caseId,
                                                                        Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType,
                                                                        boolean singleInstanceMode)

See getPlanItemInstances(String, Class, boolean, TransitionData) (passing null as transitionData).

getPlanItemInstances

List<com.edorasware.cmmn.model.structure.PlanItem> getPlanItemInstances(String caseId,
                                                                        Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType,
                                                                        boolean singleInstanceMode,
                                                                        com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelInspector.getPlanItemInstances(String, Class, boolean, TransitionData, PersistenceListeners)

getPlanItemProperties

Map<String,Object> getPlanItemProperties(String caseId,
                                         String planItemId,
                                         String[] properties)

See getPlanItemProperties(String, String, String[], TransitionData) (passing null as transitionData).

getPlanItemProperties

Map<String,Object> getPlanItemProperties(String caseId,
                                         String planItemId,
                                         String[] properties,
                                         com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelInspector.getPlanItemProperties(String, String, String[], TransitionData, PersistenceListeners, EvaluationListeners)

getPlanItemProperties

List<Map<String,Object>> getPlanItemProperties(String caseId,
                                               Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType,
                                               boolean singleInstanceMode,
                                               String[] properties)

See getPlanItemProperties(String, Class, boolean, String[], TransitionData) perties(WorkObjectId, Class, boolean, String[])} (passing null as transitionData).

getPlanItemProperties

List<Map<String,Object>> getPlanItemProperties(String caseId,
                                               Class<? extends com.edorasware.cmmn.model.structure.PlanItem> planItemType,
                                               boolean singleInstanceMode,
                                               String[] properties,
                                               com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelInspector.getPlanItemProperties(String, Class, boolean, String[], TransitionData, PersistenceListeners, EvaluationListeners)

getCaseFileItemInstances

List<com.edorasware.cmmn.model.casefile.CaseFileItem> getCaseFileItemInstances(String caseId,
                                                                               String definitionType)

See getCaseFileItemInstances(String, String, TransitionData) (passing null as transitionData).

getCaseFileItemInstances

List<com.edorasware.cmmn.model.casefile.CaseFileItem> getCaseFileItemInstances(String caseId,
                                                                               String definitionType,
                                                                               com.edorasware.cmmn.model.TransitionData transitionData)

See StateModelInspector.getCaseFileItemInstances(String, String, com.edorasware.cmmn.model.TransitionData, com.edorasware.cmmn.engine.hooks.PersistenceListeners)

parameters

com.edorasware.cmmn.model.TransitionData parameters(Object... keyValues)

Create a TransitionData object containing parameter key/value pairs as passed in. Pass as many key/value pairs as desired. For example: parameters(key1, value1, key2, value2).

Parameters:

keyValues - the key/value pairs.

Returns:

the TransitionData object constructed with the passed parameter key/value pairs.

formData

com.edorasware.cmmn.model.TransitionData formData(Object... keyValues)

Create a TransitionData object containing formData key/value pairs as passed in. Pass as many key/value pairs as desired. For example: formData(key1, value1, key2, value2).

Parameters:

keyValues - the key/value pairs.

Returns:

the TransitionData object constructed with the passed formData key/value pairs.

resolveId

String resolveId(Object workObjectId)

Best effort work object Id resolution. Work-around for ticket https://jira.edorasware.com/browse/CLD-8287 (typed work object Ids may get converted to a string on an FE round-trip).

Returns:

the input parameter unchanged if it is of type WorkObjectId. Otherwise, if it is of type String, try to convert it into a WorkObjectId (and return it). Otherwise return null.

resolveIdFromExternalId

String resolveIdFromExternalId(Object workObjectId)

Similar to resolveId(Object) with the difference that the Id passed in the input parameter is expected to be an external work object Id. The Id returned is the external Id’s internal Id.

isCurrentUserAllowedToBrowseToWorkObject

boolean isCurrentUserAllowedToBrowseToWorkObject(com.edorasware.commons.core.any.AnyWorkObject workObject)

Check if the current user is allowed to browse (i.e. navigate to) the passed Work Object.