com.edorasware.one.cmmn

Interface CmmnManager

All Known Implementing Classes:

DefaultCmmnManager

public interface CmmnManager

Exposes API for various CMMN actions.

Method Summary

Modifier and Type	Method and Description
void	caseFileItemTransition(String ambiguousCaseClientId, String caseFileItemId, String caseFileItemTransition, Map<String,Object> frontendObjectMap) Handles case file item transitions with given form data.
List<CurrentState>	currentStates(String ambiguousCaseClientId, Map<String,String[]> parameterMap) Gets the list of current states of a case.
void	discretionaryItemPlanning(String ambiguousCaseClientId, String discretionaryItemId, Map<String,Object> frontendObjectMap) Applies the planning action on the specified discretionary item.
List<Map<String,Object>>	planItemProperties(String ambiguousCaseClientId, String planItemType, Boolean singleInstanceMode, String properties, Map<String,String[]> parameterMap) Gets the plan item properties along with their values for each plan item instance of the given plan item type.
Map<String,Object>	planItemPropertiesSingle(String ambiguousCaseClientId, String planItemId, String properties, Map<String,String[]> parameterMap) Gets the plan item properties along with their values for the given comma separated list of properties.
Map<String,String>	planItemTransition(String ambiguousCaseClientId, String planItemId, String planItemTransition, Map<String,Object> frontendObjectMap) Handles plan item transitions with given form data.
void	stateUpdate(String caseClientAmbiguousId, Map<String,Object> frontendObjectMap) Update state of a case.

Method Detail

stateUpdate

void stateUpdate(String caseClientAmbiguousId,
                 Map<String,Object> frontendObjectMap)

Update state of a case.

Parameters:

caseClientAmbiguousId - the ID of the case (either work object ID value or global ID value)

frontendObjectMap - form data

planItemTransition

Map<String,String> planItemTransition(String ambiguousCaseClientId,
                                      String planItemId,
                                      String planItemTransition,
                                      Map<String,Object> frontendObjectMap)

Handles plan item transitions with given form data.

Parameters:

ambiguousCaseClientId - the ID of the case (either work object ID value or global ID value)

planItemId - ID of plan item for which the transition is to be handled

planItemTransition - plan item transition to be handled

frontendObjectMap - form data

Returns:

Forward map containing info on where the user is to be forwarded to.

caseFileItemTransition

void caseFileItemTransition(String ambiguousCaseClientId,
                            String caseFileItemId,
                            String caseFileItemTransition,
                            Map<String,Object> frontendObjectMap)

Handles case file item transitions with given form data.

Parameters:

ambiguousCaseClientId - the ID of the case (either work object ID value or global ID value)

caseFileItemId - id of case file item for which the transition is to be handled

caseFileItemTransition - case file item transition to be handled

frontendObjectMap - form data

currentStates

List<CurrentState> currentStates(String ambiguousCaseClientId,
                                 Map<String,String[]> parameterMap)

Gets the list of current states of a case.

Parameters:

ambiguousCaseClientId - the ID of the case (either work object ID value or global ID value)

parameterMap - map of parameters

Returns:

list of current-states

planItemPropertiesSingle

Map<String,Object> planItemPropertiesSingle(String ambiguousCaseClientId,
                                            String planItemId,
                                            String properties,
                                            Map<String,String[]> parameterMap)

Gets the plan item properties along with their values for the given comma separated list of properties.

Parameters:

ambiguousCaseClientId - the ID of the case (either work object ID value or global ID value)

planItemId - id of plan item for which the transition is to be handled

properties - comma separated list of property names

parameterMap - map of parameters

Returns:

map of plan item properties along with their values

planItemProperties

List<Map<String,Object>> planItemProperties(String ambiguousCaseClientId,
                                            String planItemType,
                                            Boolean singleInstanceMode,
                                            String properties,
                                            Map<String,String[]> parameterMap)

Gets the plan item properties along with their values for each plan item instance of the given plan item type.

Parameters:

ambiguousCaseClientId - the ID of the case (either work object ID value or global ID value)

planItemType - type of plan item

singleInstanceMode - flag to indicate the single instance mode

properties - comma separated list of property names

parameterMap - map of parameters

Returns:

list of maps, each map has plan item properties along with their values for one plan item instance

discretionaryItemPlanning

void discretionaryItemPlanning(String ambiguousCaseClientId,
                               String discretionaryItemId,
                               Map<String,Object> frontendObjectMap)

Applies the planning action on the specified discretionary item.

Parameters:

ambiguousCaseClientId - the ID of the case (either work object ID value or global ID value)

discretionaryItemId - ID of the discretionary item

frontendObjectMap - form data