ModelConstants (edoras one Java API (2.0.7))

java.lang.Object
- com.edorasware.cmmn.engine.utility.ModelConstants

public class ModelConstants
extends Object

Contains CMMN related utility constants.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_DESCRIPTION` A custom attribute which holds an optional action description for a model element.
`static String`	`ACTION_GROUPS` An extension namespace attribute holding an optional list of candidate group IDs.
`static String`	`ACTION_NAME` A custom attribute which holds an optional action name for a model element.
`static String`	`ACTION_ORDER` A custom attribute.
`static String`	`ACTION_USERS` An extension namespace attribute holding an optional list of candidate user IDs.
`static String`	`ADD_COMMENT_TASK_TYPE` The service task type for the Add comment task.
`static String`	`AUTO_COMPLETE` A custom attribute.
`static String`	`AUTO_COMPLETE_VALUE` A custom attribute value for the `CUSTOM_TYPE` attribute name.
`static String`	`CASE_ID_VARIABLE` Case Tasks only: An extension namespace attribute holding an optional variable name under which to store the id of the spawned sub case in the parent case.
`static String`	`CASE_INPUT` Case Tasks only: An extension namespace attribute allowing to specify an input parameter map.
`static String`	`CASE_NAME` Case Tasks only: A custom attribute which holds an optional case name.
`static String`	`CASE_OUTPUT` Case Tasks only: An extension namespace attribute allowing to specify an output parameter map.
`static String`	`CASE_SCOPE` Case Tasks only: An extension namespace attribute allowing to specify whether a case task should be spawned as a sub-case or as a top-level case.
`static String`	`CASE_TASK_BLOCKING` A client properties attribute.
`static String`	`CASE_TASK_PLAN_ITEM_ID` A client properties attribute.
`static String`	`CASE_TASK_SCOPE` A client properties attribute.
`static String`	`COMPLETION_NEUTRAL` An extension namespace attribute holding an optional boolean value controlling event listener behavior wrt stage completion.
`static String`	`CREATE_DOCUMENT_TASK_TYPE` The service task type for the Create document task.
`static String`	`CUSTOM_ATTRIBUTES` CMMN extensions are provided in the XML as part of this custom attribute.
`static String`	`CUSTOM_STATE_PREFIX` A prefix that allows to store string key/value pairs in the `customState` map of a plan item.
`static String`	`CUSTOM_TYPE` A custom attribute.
`static String`	`DMN_RULE_TASK_TYPE` The service task type for the evaluating DMN rules.
`static String`	`EXTENSION_NAMESPACE`
`static String`	`EXTENSION_TYPE` A custom attribute.
`static String`	`FORCE` A custom attribute value for the `VISIBILITY` attribute name.
`static String`	`HIDE_ACTION_IF` A custom attribute.
`static String`	`I18N_ATTRIBUTE_PREFIX` A prefix for i18n translation attribute keys (e.g. i18n.de.name).
`static String`	`INIT_VARIABLES_TASK_TYPE` The service task type for the Init variables task.
`static String`	`MANUAL_REPETITION` A custom attribute.
`static String`	`PARAMETER_PREFIX` A prefix that allows to mark formData entries as parameters.
`static String`	`PLAN_ITEM` The key under which the current plan item is stored (e.g. for expression evaluation).
`static String`	`PLAN_ITEM_ID` The variable name under which the CMMN plan item instance Id is added to the form data map of `TransitionData`.
`static String`	`PLAN_ITEMS` The key under which the plan item look-up map is stored (e.g. for expression evaluation).
`static String`	`PROCESS_ID_VARIABLE` Process Tasks only: An extension namespace attribute holding an optional variable name under which to store the id of the spawned process in the parent case.
`static String`	`PROCESS_INPUT` Process Tasks only: An extension namespace attribute allowing to specify an input parameter map.
`static String`	`PROCESS_NAME` BPMN Process Tasks only: A custom attribute which holds an optional process name.
`static String`	`PROCESS_OUTPUT` Process Tasks only: An extension namespace attribute allowing to specify an output parameter map.
`static String`	`REPETITION` A custom attribute.
`static String`	`SEND_MAIL_TASK_TYPE` The service task type for the Send Mail task.
`static String`	`SERVICE_TYPE` Process Tasks only: An extension namespace attribute that defines the type of service task the given Process Task element represents.
`static String`	`STANDARD_CMMN` A custom attribute value.
`static String`	`STATE_VISIBLE` A custom attribute.
`static String`	`TASK_ID_VARIABLE` Human Tasks only: An extension namespace attribute holding an optional variable name under which to store the id of the started task in the parent case.
`static String`	`TASK_INPUT` Human Tasks only: An extension namespace attribute allowing to specify an input parameter map.
`static String`	`Task_OUTPUT` Human Tasks only: An extension namespace attribute allowing to specify an output parameter map.
`static String`	`TIMER_EVENT_BASE` Part of the timer event listener implementation contract.
`static String`	`TIMER_EVENT_REPEATS` Part of the timer event listener implementation contract.
`static String`	`TRIGGER_ITEM` The key under which the default trigger item is stored (e.g. for expression evaluation).
`static String`	`TRIGGER_ITEMS` The key under which trigger items are stored (e.g. for expression evaluation).
`static String`	`TRIGGER_LIMIT` A custom attribute for the case plan model allowing to set an optional plan item trigger limit.
`static String`	`TRIGGER_MODE` An extension namespace attribute holding a sentry’s trigger mode.
`static String`	`VISIBILITY` A custom attribute.
`static String`	`VISUALIZATION_ORDER` A custom attribute.

Method Summary
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EXTENSION_NAMESPACE
```
public static final String EXTENSION_NAMESPACE
```
    See Also:
    
    Constant Field Values
  - ACTION_USERS
```
public static final String ACTION_USERS
```
    An extension namespace attribute holding an optional list of candidate user IDs.
    
    See Also:
    
    Constant Field Values
  - ACTION_GROUPS
```
public static final String ACTION_GROUPS
```
    An extension namespace attribute holding an optional list of candidate group IDs.
    
    See Also:
    
    Constant Field Values
  - CASE_ID_VARIABLE
```
public static final String CASE_ID_VARIABLE
```
    Case Tasks only: An extension namespace attribute holding an optional variable name under which to store the id of the spawned sub case in the parent case.
    
    See Also:
    
    Constant Field Values
  - PROCESS_ID_VARIABLE
```
public static final String PROCESS_ID_VARIABLE
```
    Process Tasks only: An extension namespace attribute holding an optional variable name under which to store the id of the spawned process in the parent case.
    
    See Also:
    
    Constant Field Values
  - TASK_ID_VARIABLE
```
public static final String TASK_ID_VARIABLE
```
    Human Tasks only: An extension namespace attribute holding an optional variable name under which to store the id of the started task in the parent case.
    
    See Also:
    
    Constant Field Values
  - CASE_SCOPE
```
public static final String CASE_SCOPE
```
    Case Tasks only: An extension namespace attribute allowing to specify whether a case task should be spawned as a sub-case or as a top-level case.
    
    See Also:
    
    Constant Field Values
  - CASE_INPUT
```
public static final String CASE_INPUT
```
    Case Tasks only: An extension namespace attribute allowing to specify an input parameter map. The attribute value holds a JSON encoded map.
    
    See Also:
    
    Constant Field Values
  - PROCESS_INPUT
```
public static final String PROCESS_INPUT
```
    Process Tasks only: An extension namespace attribute allowing to specify an input parameter map. The attribute value holds a JSON encoded map.
    
    See Also:
    
    Constant Field Values
  - TASK_INPUT
```
public static final String TASK_INPUT
```
    Human Tasks only: An extension namespace attribute allowing to specify an input parameter map. The attribute value holds a JSON encoded map.
    
    See Also:
    
    Constant Field Values
  - CASE_OUTPUT
```
public static final String CASE_OUTPUT
```
    Case Tasks only: An extension namespace attribute allowing to specify an output parameter map. The attribute value holds a JSON encoded map.
    
    See Also:
    
    Constant Field Values
  - PROCESS_OUTPUT
```
public static final String PROCESS_OUTPUT
```
    Process Tasks only: An extension namespace attribute allowing to specify an output parameter map. The attribute value holds a JSON encoded map.
    
    See Also:
    
    Constant Field Values
  - SERVICE_TYPE
```
public static final String SERVICE_TYPE
```
    Process Tasks only: An extension namespace attribute that defines the type of service task the given Process Task element represents.
    
    If the attribute is missing, we have two possible situations: we either have a BpmnProcessTask (the model element has a non-empty processRef attribute), or else, we have a simple service task of type ExpressionEvaluationServiceTask (which is, for backwards compatibility reasons, the default service task).
    
    See Also:
    
    Constant Field Values
  - SEND_MAIL_TASK_TYPE
```
public static final String SEND_MAIL_TASK_TYPE
```
    The service task type for the Send Mail task.
    
    See Also:
    
    Constant Field Values
  - CREATE_DOCUMENT_TASK_TYPE
```
public static final String CREATE_DOCUMENT_TASK_TYPE
```
    The service task type for the Create document task.
    
    See Also:
    
    Constant Field Values
  - INIT_VARIABLES_TASK_TYPE
```
public static final String INIT_VARIABLES_TASK_TYPE
```
    The service task type for the Init variables task.
    
    See Also:
    
    Constant Field Values
  - ADD_COMMENT_TASK_TYPE
```
public static final String ADD_COMMENT_TASK_TYPE
```
    The service task type for the Add comment task.
    
    See Also:
    
    Constant Field Values
  - DMN_RULE_TASK_TYPE
```
public static final String DMN_RULE_TASK_TYPE
```
    The service task type for the evaluating DMN rules.
    
    See Also:
    
    Constant Field Values
  - Task_OUTPUT
```
public static final String Task_OUTPUT
```
    Human Tasks only: An extension namespace attribute allowing to specify an output parameter map. The attribute value holds a JSON encoded map.
    
    See Also:
    
    Constant Field Values
  - COMPLETION_NEUTRAL
```
public static final String COMPLETION_NEUTRAL
```
    An extension namespace attribute holding an optional boolean value controlling event listener behavior wrt stage completion.
    
    See Also:
    
    Constant Field Values
  - TRIGGER_MODE
```
public static final String TRIGGER_MODE
```
    An extension namespace attribute holding a sentry’s trigger mode.
    
    See Also:
    
    Constant Field Values
  - CUSTOM_ATTRIBUTES
```
public static final String CUSTOM_ATTRIBUTES
```
    CMMN extensions are provided in the XML as part of this custom attribute. The actual extension values are provided in the value of this attribute, encoded as a JSON string.
    
    See Also:
    
    Constant Field Values
  - ACTION_NAME
```
public static final String ACTION_NAME
```
    A custom attribute which holds an optional action name for a model element. The action name is used whenever a GUI action button or similar command element has to be rendered for the model element.
    
    See Also:
    
    Constant Field Values
  - CASE_NAME
```
public static final String CASE_NAME
```
    Case Tasks only: A custom attribute which holds an optional case name.
    
    See Also:
    
    Constant Field Values
  - PROCESS_NAME
```
public static final String PROCESS_NAME
```
    BPMN Process Tasks only: A custom attribute which holds an optional process name.
    
    See Also:
    
    Constant Field Values
  - ACTION_DESCRIPTION
```
public static final String ACTION_DESCRIPTION
```
    A custom attribute which holds an optional action description for a model element. The action description is used whenever a GUI action button or similar command element has to be rendered for the model element.
    
    See Also:
    
    Constant Field Values
  - EXTENSION_TYPE
```
public static final String EXTENSION_TYPE
```
    A custom attribute. It is used to set the type of a case file item in the modeler. Holds a string naming the desired extension type.
    
    See Also:
    
    Constant Field Values
  - HIDE_ACTION_IF
```
public static final String HIDE_ACTION_IF
```
    A custom attribute. It is used to hide an action button based on an expression.
    
    See Also:
    
    Constant Field Values
  - MANUAL_REPETITION
```
public static final String MANUAL_REPETITION
```
    A custom attribute. Allows user-triggered repetition of user event listeners (in which case it holds an expression which is dynamically evaluated).
    
    See Also:
    
    Constant Field Values
  - AUTO_COMPLETE
```
public static final String AUTO_COMPLETE
```
    A custom attribute. Allows an expression for the otherwise literal boolean autoComplete property of a stage.
    
    See Also:
    
    Constant Field Values
  - TRIGGER_LIMIT
```
public static final String TRIGGER_LIMIT
```
    A custom attribute for the case plan model allowing to set an optional plan item trigger limit.
    
    See Also:
    
    Constant Field Values
  - REPETITION
```
public static final String REPETITION
```
    A custom attribute. See {#link #STANDARD_CMMN}.
    
    See Also:
    
    Constant Field Values
  - STANDARD_CMMN
```
public static final String STANDARD_CMMN
```
    A custom attribute value. Specify this for the REPETITION attribute on the case plan model in order to disable automatic repetition of tasks.
    
    See Also:
    
    Constant Field Values
  - STATE_VISIBLE
```
public static final String STATE_VISIBLE
```
    A custom attribute. Applies to stages and milestones. Determines whether they will be visually represented in the case GUI. Holds an expression which is dinamically evaluated.
    
    See Also:
    
    Constant Field Values
  - VISUALIZATION_ORDER
```
public static final String VISUALIZATION_ORDER
```
    A custom attribute. Applies to stages and milestones. Determines the visualization order (only valid in combination with STATE_VISIBLE). Holds an integer.
    
    See Also:
    
    Constant Field Values
  - ACTION_ORDER
```
public static final String ACTION_ORDER
```
    A custom attribute. Applies to all model elements which result in the rendering of an action button. Helps determine the order in which the action buttons are rendered relative to each other. Holds an integer.
    
    See Also:
    
    Constant Field Values
  - CUSTOM_TYPE
```
public static final String CUSTOM_TYPE
```
    A custom attribute. Can be used to modify the behavior of a plan item. Current application is type=autoComplete for user event listeners.
    
    See Also:
    
    Constant Field Values
  - AUTO_COMPLETE_VALUE
```
public static final String AUTO_COMPLETE_VALUE
```
    A custom attribute value for the CUSTOM_TYPE attribute name. Used to denote user event listener plan items as autoComplete.
    
    See Also:
    
    Constant Field Values
  - VISIBILITY
```
public static final String VISIBILITY
```
    A custom attribute. Can be used to modify the behavior of a user event listener.
    
    See Also:
    
    Constant Field Values
  - FORCE
```
public static final String FORCE
```
    A custom attribute value for the VISIBILITY attribute name. Used to mark user event listener to always show, regardless whether clicking it has an effect or not.
    
    See Also:
    
    Constant Field Values
  - PARAMETER_PREFIX
```
public static final String PARAMETER_PREFIX
```
    A prefix that allows to mark formData entries as parameters. See TransitionData
    
    See Also:
    
    Constant Field Values
  - CUSTOM_STATE_PREFIX
```
public static final String CUSTOM_STATE_PREFIX
```
    A prefix that allows to store string key/value pairs in the customState map of a plan item.
    
    See Also:
    
    Constant Field Values
  - TRIGGER_ITEMS
```
public static final String TRIGGER_ITEMS
```
    The key under which trigger items are stored (e.g. for expression evaluation).
    
    See Also:
    
    Constant Field Values
  - TRIGGER_ITEM
```
public static final String TRIGGER_ITEM
```
    The key under which the default trigger item is stored (e.g. for expression evaluation).
    
    See Also:
    
    Constant Field Values
  - PLAN_ITEMS
```
public static final String PLAN_ITEMS
```
    The key under which the plan item look-up map is stored (e.g. for expression evaluation).
    
    See Also:
    
    Constant Field Values
  - PLAN_ITEM
```
public static final String PLAN_ITEM
```
    The key under which the current plan item is stored (e.g. for expression evaluation).
    
    See Also:
    
    Constant Field Values
  - PLAN_ITEM_ID
```
public static final String PLAN_ITEM_ID
```
    The variable name under which the CMMN plan item instance Id is added to the form data map of TransitionData. This allows client code in their create or start handler to store that value as a back-reference to the owning plan item of the parent case.
    
    See Also:
    
    Constant Field Values
  - I18N_ATTRIBUTE_PREFIX
```
public static final String I18N_ATTRIBUTE_PREFIX
```
    A prefix for i18n translation attribute keys (e.g. i18n.de.name).
    
    See Also:
    
    Constant Field Values
  - CASE_TASK_SCOPE
```
public static final String CASE_TASK_SCOPE
```
    A client properties attribute. Contains the same values as the CASE_SCOPE extension name space attribute. State models representing case tasks (cases created as a result of a case task) contain an entry with this key in their client properties. Possible values are the ones from enumeration CaseTask.CaseTaskScope (as a string).
    
    See Also:
    
    Constant Field Values
  - CASE_TASK_PLAN_ITEM_ID
```
public static final String CASE_TASK_PLAN_ITEM_ID
```
    A client properties attribute. It is only stored for cases created out of a CaseTask plan item. The value contained in the property is a string holding the plan item instance Id of the CaseTask plan item that created the case.
    
    See Also:
    
    Constant Field Values
  - CASE_TASK_BLOCKING
```
public static final String CASE_TASK_BLOCKING
```
    A client properties attribute. It is only stored for cases created out of a CaseTask plan item. The value contained in the property is a string holding either 'true' or 'false', indicating whether the case is a blocking or non-blocking case task as viewed by the case that started the case task.
    
    See Also:
    
    Constant Field Values
  - TIMER_EVENT_BASE
```
public static final String TIMER_EVENT_BASE
```
    Part of the timer event listener implementation contract. An ISO_8601 formatted date/time string that is passed under this parameter name to the timer create handler.
    
    See Also:
    
    Constant Field Values
  - TIMER_EVENT_REPEATS
```
public static final String TIMER_EVENT_REPEATS
```
    Part of the timer event listener implementation contract. A parameter passed to the CMMN engine when triggering an occur transition for a timer event listener. Pass an integer formatted as a String as a parameter with this name to the engine to allow repeated timers. For a repeatable timer, the engine will check the number of already received timer events for the model element. If the _timerRepeats limit is not reached yet, the engine will create a new timer instance and set it to AVAILABLE. A missing parameter is interpreted as "0".
    
    <p>As a result of creating the new timer instance in the CMMN engine, its create handler is called with the TIMER_EVENT_BASE parameter, allowing the create handler to set up the next back-ground (i.e. system) timer for the calculated next due time.</p>
    
    See Also:
    
    Constant Field Values

Class ModelConstants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXTENSION_NAMESPACE

ACTION_USERS

ACTION_GROUPS

CASE_ID_VARIABLE

PROCESS_ID_VARIABLE

TASK_ID_VARIABLE

CASE_SCOPE

CASE_INPUT

PROCESS_INPUT

TASK_INPUT

CASE_OUTPUT

PROCESS_OUTPUT

SERVICE_TYPE

SEND_MAIL_TASK_TYPE

CREATE_DOCUMENT_TASK_TYPE

INIT_VARIABLES_TASK_TYPE

ADD_COMMENT_TASK_TYPE

DMN_RULE_TASK_TYPE

Task_OUTPUT

COMPLETION_NEUTRAL

TRIGGER_MODE

CUSTOM_ATTRIBUTES

ACTION_NAME

CASE_NAME

PROCESS_NAME

ACTION_DESCRIPTION

EXTENSION_TYPE

HIDE_ACTION_IF

MANUAL_REPETITION

AUTO_COMPLETE

TRIGGER_LIMIT

REPETITION

STANDARD_CMMN

STATE_VISIBLE

VISUALIZATION_ORDER

ACTION_ORDER

CUSTOM_TYPE

AUTO_COMPLETE_VALUE

VISIBILITY

FORCE

PARAMETER_PREFIX

CUSTOM_STATE_PREFIX

TRIGGER_ITEMS

TRIGGER_ITEM

PLAN_ITEMS

PLAN_ITEM

PLAN_ITEM_ID

I18N_ATTRIBUTE_PREFIX

CASE_TASK_SCOPE

CASE_TASK_PLAN_ITEM_ID

CASE_TASK_BLOCKING

TIMER_EVENT_BASE

TIMER_EVENT_REPEATS