com.edorasware.cmmn.one

Class CmmnHelper

java.lang.Object

com.edorasware.cmmn.one.CmmnHelper

public final class CmmnHelper
extends Object

Static helper methods operating on the structure of a CMMN XML.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	archiveCase(String caseClientId, com.edorasware.commons.core.entity.State state, com.edorasware.commons.core.entity.UserId runAsUser, com.edorasware.commons.core.any.AnyWorkObjectService anyWorkObjectService, CaseArchiveManager caseArchiveManager, com.edorasware.commons.core.identity.CurrentUserService currentUserService) Archive a case by setting the passed state.
static void	archiveParentCaseRecursive(com.edorasware.cmmn.model.structure.CasePlanModel caze, com.edorasware.commons.core.entity.UserId runAsUser, com.edorasware.cmmn.model.TransitionData transitionData, com.edorasware.cmmn.engine.hooks.PersistenceListeners persistenceListeners, com.edorasware.cmmn.engine.core.CmmnService cmmnService, com.edorasware.commons.core.any.AnyWorkObjectService anyWorkObjectService, CaseArchiveManager caseArchiveManager, com.edorasware.commons.core.identity.CurrentUserService currentUserService) If we're archiving a non-blocking sub-case, we may have to check for terminal parent cases which can now also be archived.
static void	collectPlanItems(com.edorasware.cmmn.model.xml.TStage stage, List<com.edorasware.cmmn.model.xml.TPlanItem> result, Class<? extends com.edorasware.cmmn.model.xml.TPlanItemDefinition> type) Recursively visit stages and collect plan items that are assignable to the type passed in (including stages themselves provided the type parameter matches the stage's type).
static com.edorasware.cmmn.model.TransitionData	createTransitionData(Map<String,Object> formData, Map<String,Object> parameters, User user)
static com.edorasware.cmmn.model.TransitionData	createTransitionData(Map<String,String[]> parameters, User user)
static com.edorasware.cmmn.model.TransitionData	createTransitionData(User user)
static List<com.edorasware.cmmn.model.xml.THumanTask>	extractHumanTasks(com.edorasware.cmmn.model.xml.TDefinitions tDefinitions) Given the structure of a CMMN XML in tDefinitions, navigate though it and return all contained THumanTask elements as a list.
static List<com.edorasware.cmmn.model.xml.TPlanItem>	extractPlanItems(com.edorasware.cmmn.model.xml.TDefinitions tDefinitions, Class<? extends com.edorasware.cmmn.model.xml.TPlanItemDefinition> type) Given the structure of a CMMN XML in tDefinitions, navigate though it and return all plan items that are assignable to the type passed in.
static com.edorasware.commons.core.any.AnyWorkObject	findWorkObject(com.edorasware.commons.core.any.AnyWorkObjectService anyWorkObjectService, com.edorasware.commons.core.entity.WorkObjectId workObjectId)
static com.edorasware.commons.core.any.AnyWorkObject	findWorkObject(com.edorasware.commons.core.any.AnyWorkObjectService anyWorkObjectService, com.edorasware.commons.core.entity.WorkObjectId workObjectId, boolean withVariables)
static com.edorasware.cmmn.model.xml.TCase	getCase(com.edorasware.cmmn.model.xml.TDefinitions tDefinitions) Get the case for a CMMN XML.
static String	getInitFormRef(com.edorasware.cmmn.model.structure.PlanItem planItem, com.edorasware.commons.core.any.AnyWorkObjectDefinitionService workObjectDefinitionService) Implementation for ticket CLD-7314 (supporting Case Task and Process Task init forms).
static com.edorasware.commons.core.entity.UserId	getWorkObjectOwnerId(com.edorasware.commons.core.any.AnyWorkObjectService anyWorkObjectService, com.edorasware.commons.core.entity.WorkObjectId workObjectId)
static boolean	handleSpecificFields(com.edorasware.commons.core.service.entity.WorkObjectService workObjectService, com.edorasware.commons.core.entity.WorkObjectId workObjectId, String variableName, Object variableValue, BaseVariableHandlingService variableHandlingService) Important: The same set of variables is dealt with in other methods in this class.
static boolean	handleSpecificFields(com.edorasware.commons.core.entity.WorkObject builderTemplate, com.edorasware.commons.core.entity.WorkObject.WorkObjectBuilder builder, String variableName, Object variableValue, BaseVariableHandlingService variableHandlingService)
static boolean	isNonBlockingSubCase(com.edorasware.cmmn.model.structure.CasePlanModel caze)
static boolean	isProcessTask(com.edorasware.cmmn.model.structure.PlanItem planItem) A ProcessTask plan item with a non blank/"EMPTY" BPMN process reference (clientRef) is considered a process task (in contrast to a service task - see isServiceTask(com.edorasware.cmmn.model.structure.PlanItem)).
static boolean	isServiceTask(com.edorasware.cmmn.model.structure.PlanItem planItem) By convention, a ProcessTask plan item with no edoras one BPMN process reference is considered a service task.
static boolean	isSet(Object object)
static HashMap<String,Object>	removeSpecialFields(Map<String,Object> inputMap)
static void	setMapValueWithDefault(Map<String,Object> map, String property, Object value, String defaultValue) Put a named property value into a map, using a default value if the passed value is null.
static void	trySetMapValueWithDefault(Map<String,Object> map, String property, Object value, String defaultValue) Put a named property value into a map, using a default value if the passed value is null.
static HashMap<String,Object>	workObjectToMap(com.edorasware.commons.core.entity.WorkObject<?,?,?> workObject)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Method Detail

archiveCase

public static boolean archiveCase(String caseClientId,
                  com.edorasware.commons.core.entity.State state,
                  com.edorasware.commons.core.entity.UserId runAsUser,
                  com.edorasware.commons.core.any.AnyWorkObjectService anyWorkObjectService,
                  CaseArchiveManager caseArchiveManager,
                  com.edorasware.commons.core.identity.CurrentUserService currentUserService)

Archive a case by setting the passed state. Archives the case with the privileges of the passed runAsUser. If the passed runAsUser is null, will archive the case with the privileges of the owner of the case to be archived.

Returns:

true, if the case was archived (state change), false if the case was already archived.

archiveParentCaseRecursive

public static void archiveParentCaseRecursive(com.edorasware.cmmn.model.structure.CasePlanModel caze,
                              com.edorasware.commons.core.entity.UserId runAsUser,
                              com.edorasware.cmmn.model.TransitionData transitionData,
                              com.edorasware.cmmn.engine.hooks.PersistenceListeners persistenceListeners,
                              com.edorasware.cmmn.engine.core.CmmnService cmmnService,
                              com.edorasware.commons.core.any.AnyWorkObjectService anyWorkObjectService,
                              CaseArchiveManager caseArchiveManager,
                              com.edorasware.commons.core.identity.CurrentUserService currentUserService)

If we're archiving a non-blocking sub-case, we may have to check for terminal parent cases which can now also be archived. Implements ticket https://jira.edorasware.com/browse/CLD-9420

isNonBlockingSubCase

public static boolean isNonBlockingSubCase(com.edorasware.cmmn.model.structure.CasePlanModel caze)

isServiceTask

public static boolean isServiceTask(com.edorasware.cmmn.model.structure.PlanItem planItem)

By convention, a ProcessTask plan item with no edoras one BPMN process reference is considered a service task. If there is a process reference, it is a true process task.

isProcessTask

public static boolean isProcessTask(com.edorasware.cmmn.model.structure.PlanItem planItem)

A ProcessTask plan item with a non blank/"EMPTY" BPMN process reference (clientRef) is considered a process task (in contrast to a service task - see isServiceTask(com.edorasware.cmmn.model.structure.PlanItem)).

extractHumanTasks

public static List<com.edorasware.cmmn.model.xml.THumanTask> extractHumanTasks(com.edorasware.cmmn.model.xml.TDefinitions tDefinitions)

Given the structure of a CMMN XML in tDefinitions, navigate though it and return all contained THumanTask elements as a list.

Parameters:

tDefinitions - the XML model in which to look.

Returns:

the list of THumanTask elements found. May be empty but never null.

extractPlanItems

public static List<com.edorasware.cmmn.model.xml.TPlanItem> extractPlanItems(com.edorasware.cmmn.model.xml.TDefinitions tDefinitions,
                                                             Class<? extends com.edorasware.cmmn.model.xml.TPlanItemDefinition> type)

Given the structure of a CMMN XML in tDefinitions, navigate though it and return all plan items that are assignable to the type passed in. Note: the CasePlanModel itself is never returned as a plan item.

Parameters:

tDefinitions - the XML model in which to look.

type - the type of plan item you're interested in.

Returns:

the list of TPlanItemDefinition elements found. May be empty but never null.

getCase

public static com.edorasware.cmmn.model.xml.TCase getCase(com.edorasware.cmmn.model.xml.TDefinitions tDefinitions)

Get the case for a CMMN XML. We only support exactly one TCase per CMMN XML.

Parameters:

tDefinitions - the root element.

Returns:

the one case element.

collectPlanItems

public static void collectPlanItems(com.edorasware.cmmn.model.xml.TStage stage,
                    List<com.edorasware.cmmn.model.xml.TPlanItem> result,
                    Class<? extends com.edorasware.cmmn.model.xml.TPlanItemDefinition> type)

Recursively visit stages and collect plan items that are assignable to the type passed in (including stages themselves provided the type parameter matches the stage's type).

Parameters:

stage - the starting stage.

result - the list to which to add the elements found.

type - the type of plan item you're interested in.

handleSpecificFields

public static boolean handleSpecificFields(com.edorasware.commons.core.entity.WorkObject builderTemplate,
                           com.edorasware.commons.core.entity.WorkObject.WorkObjectBuilder builder,
                           String variableName,
                           Object variableValue,
                           BaseVariableHandlingService variableHandlingService)

handleSpecificFields

public static boolean handleSpecificFields(com.edorasware.commons.core.service.entity.WorkObjectService workObjectService,
                           com.edorasware.commons.core.entity.WorkObjectId workObjectId,
                           String variableName,
                           Object variableValue,
                           BaseVariableHandlingService variableHandlingService)

Important: The same set of variables is dealt with in other methods in this class.

workObjectToMap

public static HashMap<String,Object> workObjectToMap(com.edorasware.commons.core.entity.WorkObject<?,?,?> workObject)

removeSpecialFields

public static HashMap<String,Object> removeSpecialFields(Map<String,Object> inputMap)

trySetMapValueWithDefault

public static void trySetMapValueWithDefault(Map<String,Object> map,
                             String property,
                             Object value,
                             String defaultValue)

Put a named property value into a map, using a default value if the passed value is null. The method only puts the value into the destination map if there is no such entry yet.

setMapValueWithDefault

public static void setMapValueWithDefault(Map<String,Object> map,
                          String property,
                          Object value,
                          String defaultValue)

Put a named property value into a map, using a default value if the passed value is null.

isSet

public static boolean isSet(Object object)

getWorkObjectOwnerId

public static com.edorasware.commons.core.entity.UserId getWorkObjectOwnerId(com.edorasware.commons.core.any.AnyWorkObjectService anyWorkObjectService,
                                                             com.edorasware.commons.core.entity.WorkObjectId workObjectId)

findWorkObject

public static com.edorasware.commons.core.any.AnyWorkObject findWorkObject(com.edorasware.commons.core.any.AnyWorkObjectService anyWorkObjectService,
                                                           com.edorasware.commons.core.entity.WorkObjectId workObjectId)

findWorkObject

public static com.edorasware.commons.core.any.AnyWorkObject findWorkObject(com.edorasware.commons.core.any.AnyWorkObjectService anyWorkObjectService,
                                                           com.edorasware.commons.core.entity.WorkObjectId workObjectId,
                                                           boolean withVariables)

createTransitionData

public static com.edorasware.cmmn.model.TransitionData createTransitionData(User user)

createTransitionData

public static com.edorasware.cmmn.model.TransitionData createTransitionData(Map<String,String[]> parameters,
                                                            User user)

createTransitionData

public static com.edorasware.cmmn.model.TransitionData createTransitionData(Map<String,Object> formData,
                                                            Map<String,Object> parameters,
                                                            User user)

getInitFormRef

public static String getInitFormRef(com.edorasware.cmmn.model.structure.PlanItem planItem,
                    com.edorasware.commons.core.any.AnyWorkObjectDefinitionService workObjectDefinitionService)

Implementation for ticket CLD-7314 (supporting Case Task and Process Task init forms).