Class icm.base.Constants

Provides a helper class that defines the constants that are used by IBM Case Manager. These constants are divided into different subcategories.

The following example shows how the constants are used:

var type = Constants.PageType.CASE_CREATE;

Defined in: <icm/base/Constants.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	icm.base.Constants()

Field Summary

Field Attributes	Field Name and Description
	CommentContext Constants related to comment contexts.
	Container Constants that are related to the container.
	CoordContext Constants that are related to the context of coordination topics through all steps of a coordination.
	CoordTopic Constants that are related to coordination topics.
	PageType Constants that identify a specific type of page.

Constructor Detail

icm.base.Constants()

Field Detail

CommentContext

Constants related to comment contexts. The CommentContext constants include the following strings:

CASE_CREATE The context when adding a comment and creating a case
CASE The context when adding a comment to a case
TASK_CREATE The context when adding a comment and creating a task
TASK_ENABLE The context when adding a comment and enabling a task
TASK_DISABLE The context when adding a comment and disabling a task
TASK_START The context when adding a comment and starting a task
TASK The context when adding a comment to a task
WORK_ITEM_COMPLETE The context when adding a comment and completing a work item
WORK_ITEM The context when adding a comment to a work item
DOCUMENT_ADD The context when adding a comment and adding a document
DOCUMENT The context when adding a comment to a document

Container

Constants that are related to the container. The Container constants include the following strings:

CASES_CONFIG_LAST_ROLE The key that is used to retrieve the last visited role value for the user who is logged in
CASES_CONFIG_LAST_SOLUTION The key that is used to retrieve the last visited solution value for the user who is logged in

CoordContext

Constants that are related to the context of coordination topics through all steps of a coordination. The CoordContext constants include the following strings:

CASE If true, indicates that the coordination is for adding, saving, or splitting a case
WKIM If true, indicates that the coordination topic is for saving or completing a work item
TODOTASK If true, indicates that the coordination topic is for to-do item
TODOTASKTYPE which indicates the task type of to-do item
TODOTASKID which indicates the id of to-do item
PARTSAVE If true, indicates that the coordination topic is for partially saving a work item
WKITEMRESPONSE The response name that the user selected

CoordTopic

Constants that are related to coordination topics. The CoordTopic constants include the following strings:

COMMIT The topic for a coordination step for page widgets to accept user inputs and processing, for example, a call to an external data service
VALIDATE The topic for a coordination step for page widgets to do data validation
BEFORESAVE The topic for a coordination step for page widgets to do preprocessing before saving changes
SAVE The topic for a coordination step for page widgets to do processing when saving changes
AFTERSAVE The topic for a coordination step for page widgets to do postprocessing after save
BEFORECOMPLETE The topic for a coordination step for page widgets to do preprocessing before completing a work item
COMPLETE The topic for a coordination step for page widgets to do processing when completing a work item
AFTERCOMPLETE The topic for a coordination step for page widgets to do postprocessing after completing a work item
BEFORECANCEL The topic for a coordination step for page widgets to do preprocessing before canceling the editing or adding of a case or work item
CANCEL The topic for a coordination step for page widgets to do processing when canceling the editing or adding of a case or work item
AFTERCANCEL The topic for a coordination step for page widgets to do postprocessing after canceling the editing or adding of a case or work item
TODO_COMMIT The topic for a coordination step for page widgets to accept user inputs and processing, for example, a call to an external data service
TODO_VALIDATE The topic for a coordination step for page widgets to do data validation
TODO_BEFORESAVE The topic for a coordination step for page widgets to do preprocessing before saving to-do changes
TODO_SAVE The topic for a coordination step for page widgets to do processing when saving to-do changes
TODO_AFTERSAVE The topic for a coordination step for page widgets to do postprocessing after save to-do
TODO_BEFORECOMPLETE The topic for a coordination step for page widgets to do preprocessing before completing a to-do item
TODO_COMPLETE The topic for a coordination step for page widgets to do processing when completing a to-do item
TODO_AFTERCOMPLETE The topic for a coordination step for page widgets to do postprocessing after completing a to-do item
TODO_BEFORESTOP The topic for a coordination step for page widgets to do preprocessing before stopping a to-do item
TODO_STOP The topic for a coordination step for page widgets to do processing when stopping a to-do item
TODO_AFTERSTOP The topic for a coordination step for page widgets to do postprocessing after stopping a to-do item
TODO_BEFORECANCEL The topic for a coordination step for page widgets to do preprocessing before canceling the editing or adding of a to-do item
TODO_CANCEL The topic for a coordination step for page widgets to do processing when canceling the editing or adding of a to-do item
TODO_AFTERCANCEL The topic for a coordination step for page widgets to do postprocessing after canceling the editing or adding of a to-do item
BEFORELOADWIDGET TODO: provide description for this and following 2 topics.
LOADWIDGET The topic for a coordination step for page widgets to indicate that a widget should now load its content.is in ready state, which means that all initialization is completed
AFTERLOADWIDGET The topic for a coordination step for page widgets to indicate that all page widgets that participate in a LOADWIDGET step are in ready state. In the context of the step, the widgetLoadTime attribute tell the exact time the widgets were in the ready state.

PageType

Constants that identify a specific type of page. The PageType constants include the following strings:

CASE A Case Details page
CASE_NEW An Add Case page
STEP A Work Detail page
STEP_LAUNCH An Add Task page
CASE_SPLIT A Split Case page
STATIC A Static page