Class ecm.model.AsyncTaskType

Extends ecm.model._ModelObject.
Represents a type of asynchronous tasks created for the ECM Task Manager. For every custom task created, a type defining what that asynchronous task is should be registered with the plug-in. An AsyncTaskType will automatically be created when the desktop loads. An AsyncTaskType will have defined widgets that will load when user interacts with that task type in the IBM Content Navigator task pane feature.
Defined in: <ecm\model\AsyncTaskType.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.AsyncTaskType()

Field Summary

Field Attributes	Field Name and Description
	asyncTaskContextMenuDefinitions The appropriate IBM Content Navigator IBM Content Navigator context menu definition id for each status of an asynchronous task.
	asyncTaskInstanceContextMenuDefinitions The appropriate IBM Content Navigator context menu definition id for each task instance status.
	canCreate Indicates whether this type of asynchronous task can be created.
	categorization An identifier that this type of asynchronous task should be classified with.
	classHandlerName The full canonical class name for this asynchronous task.
	iconClass The name of the icon style class that will represent this asynchronous task type.
	taskCreationDialogDijitClass The name of a Dojo `dijit` class that provides the creation dialog interface widget for this asynchronous task.
	taskInformationDijitClass The name of a Dojo `dijit` class that provides the information interface widget for this asynchronous task.

Fields borrowed from class ecm.model._ModelObject:: id, isRecurring, name, nameFilter, pane, status, type, userId

Methods borrowed from class ecm.model._ModelObject:: destroy, onChange, own, refresh, toString

Constructor Detail

ecm.model.AsyncTaskType()

Field Detail

asyncTaskContextMenuDefinitions

The appropriate IBM Content Navigator IBM Content Navigator context menu definition id for each status of an asynchronous task. This context menu will be displayed when a user right clicks on this task type. By default it will return a menu definition with open, refresh, and delete actions for all the statuses.

asyncTaskInstanceContextMenuDefinitions

The appropriate IBM Content Navigator context menu definition id for each task instance status. This context menu will be displayed when a user right clicks on an instance of a recurring async task. By default all the task instances will return a menu definition with open and refresh actions.

canCreate

Indicates whether this type of asynchronous task can be created. If it is true, a create button will appear in the ecm.widget.layout.TaskPane.

categorization

An identifier that this type of asynchronous task should be classified with. This will be used by ecm.widget.layout.TaskPane so users can toggle between different categorization of tasks. For example, different products can use this classifier to show only the appropriate tasks associated for their own product. By default, it will be "Navigator".

classHandlerName

The full canonical class name for this asynchronous task. This class name should match custom class you have created for the ECM Task Manager.

iconClass

The name of the icon style class that will represent this asynchronous task type.

taskCreationDialogDijitClass

The name of a Dojo dijit class that provides the creation dialog interface widget for this asynchronous task. The widget must extend the ecm.widget.taskManager.BaseTaskCreationDialog widget. An instance of the widget is created and displayed in the IBM Content Navigator task pane when the user selects to create this type of asynchronous task.

Refer to the documentation on {@link ecm.widget.taskManager.BaseTaskCreationDialog BaseTaskCreationDialog} for more information on what is required.

taskInformationDijitClass

The name of a Dojo dijit class that provides the information interface widget for this asynchronous task. The widget must extend the ecm.widget.taskManager.TaskInformationPane widget. An instance of the widget is created and displayed in the IBM Content Navigator task pane when the user selects to view this type of asynchronous task.