com.ibm.ecm.extension

Class PluginAsyncTaskType

java.lang.Object
com.ibm.ecm.extension.PluginAsyncTaskType

public abstract class PluginAsyncTaskType
extends java.lang.Object

Provides an abstract class that is extended to define an asynchronous task type provided by the plug-in. Asynchronous tasks are long running processes or services that will be used with the ECM Task Manager. Customers can create custom asynchronous tasks by following the developer's guide of the ECM Task Manager. Customers can then specify the various UIs and configurations that will be displayed in the IBM Content Navigator task pane for this particular type of task.

Field Summary

Modifier and Type	Field and Description
static long	`TASK_STATUS_COMPLETED`
static long	`TASK_STATUS_FAILED`
static long	`TASK_STATUS_INIT`
static long	`TASK_STATUS_INPROGRESS`
static long	`TASK_STATUS_PAUSED`
static long	`TASK_STATUS_PENDING`
static long	`TASK_STATUS_SCHEDULED`

Constructor Summary

Constructor and Description
`PluginAsyncTaskType()`

Method Summary

Modifier and Type	Method and Description
boolean	`canCreate()` Returns whether this type of asynchronous task can be created.
java.util.Map<java.lang.String,java.lang.String>	`getAsyncTaskContextMenuDefinitions()` Returns the appropriate IBM Content Navigator context menu definition id for each status of an asynchronous task.
java.util.Map<java.lang.String,java.lang.String>	`getAsyncTaskInstanceContextMenuDefinitions()` Returns the appropriate IBM Content Navigator context menu definition id for each task instance status.
java.lang.String	`getCategorization()` An identifier that this type of asynchronous task should be classified with.
abstract java.lang.String	`getClassHandlerName()` Returns the full canonical class name for this asynchronous task.
java.lang.String	`getIconClass()` Returns the name of the icon style class that will represent this asynchronous task type.
java.lang.String	`getId()` Returns an identifier that is used to describe this menu.
abstract java.lang.String	`getName(java.util.Locale locale)` Returns a descriptive label for this task that is displayed in the IBM Content Navigator task pane.
java.lang.String	`getTaskCreationDialogDijitClass()` Returns the name of a Dojo `dijit` class that provides the creation dialog interface widget for this asynchronous task.
java.lang.String	`getTaskInformationDijitClass()` Returns the name of a Dojo `dijit` class that provides the information interface widget for this asynchronous task.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

TASK_STATUS_INIT

public static long TASK_STATUS_INIT

TASK_STATUS_PENDING

public static long TASK_STATUS_PENDING

TASK_STATUS_INPROGRESS

public static long TASK_STATUS_INPROGRESS

TASK_STATUS_COMPLETED

public static long TASK_STATUS_COMPLETED

TASK_STATUS_PAUSED

public static long TASK_STATUS_PAUSED

TASK_STATUS_FAILED

public static long TASK_STATUS_FAILED

TASK_STATUS_SCHEDULED

public static long TASK_STATUS_SCHEDULED

Constructor Detail

PluginAsyncTaskType

public PluginAsyncTaskType()

Method Detail

getClassHandlerName

public abstract java.lang.String getClassHandlerName( )

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

Returns:

A full canonical class name (including packages) for this asynchronous task

getId

public java.lang.String getId()

Returns an identifier that is used to describe this menu.

Important: This identifier is used in URLs so it must contain only alphanumeric characters.

Returns:

An alphanumeric String that is used to identify the menu.

getName

public abstract java.lang.String getName( java.util.Locale locale)

Returns a descriptive label for this task that is displayed in the IBM Content Navigator task pane.

Returns:

A short description for the menu.

getTaskCreationDialogDijitClass

public java.lang.String getTaskCreationDialogDijitClass( )

Returns 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 BaseTaskCreationDialog for more information on what is required.

getTaskInformationDijitClass

public java.lang.String getTaskInformationDijitClass( )

Returns 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.

Refer to the documentation on BaseTaskInformationPane for more information on what is required.

getAsyncTaskContextMenuDefinitions

public java.util.Map<java.lang.String,java.lang.String> getAsyncTaskContextMenuDefinitions( )

Returns the appropriate 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.

Returns:

A mapping that contains a menu definition id for each task status. The task statuses are long values and can be obtained by the following public constants in this class.

TASK_STATUS_INIT
TASK_STATUS_PENDING
TASK_STATUS_INPROGRESS
TASK_STATUS_COMPLETED
TASK_STATUS_PAUSED
TASK_STATUS_FAILED
TASK_STATUS_SCHEDULED

getAsyncTaskInstanceContextMenuDefinitions

public java.util.Map<java.lang.String,java.lang.String> getAsyncTaskInstanceContextMenuDefinitions( )

Returns 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.

Returns:

A mapping that contains a menu definition id for each status of this async task instance. The statuses are long values and can be obtained by the following public constants in this class.

TASK_STATUS_INIT
TASK_STATUS_PENDING
TASK_STATUS_INPROGRESS
TASK_STATUS_COMPLETED
TASK_STATUS_PAUSED
TASK_STATUS_FAILED
TASK_STATUS_SCHEDULED

getIconClass

public java.lang.String getIconClass( )

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

Returns:

The name of the icon style class.

canCreate

public boolean canCreate()

Returns whether this type of asynchronous task can be created. If it returns true, a create button will appear in the TaskPane.

Returns:

A boolean on whether this task can be created

getCategorization

public java.lang.String getCategorization( )

An identifier that this type of asynchronous task should be classified with. This will be used by ecm.widget.layout.TaskPane widget 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".