HumanTaskManagerService interface

The HumanTaskManagerService interface exposes task-related functions that can be called by a local or a remote client.

The methods that can be called depend on the state of the task and the authorization of the person that uses the application containing the method. The main methods for manipulating task objects are listed here. For more information about these methods and the other methods that are available in the HumanTaskManagerService interface, see the Javadoc in the com.ibm.task.api package.

Task templates

The following methods are available to work with task templates.

Table 1. API methods for task templates
Method Description
getTaskTemplate Retrieves the specified task template.
createAndCallTask Creates and runs a task instance from the specified task template and waits synchronously for the result.
createAndStartTask Creates and starts a task instance from the specified task template.
createTask Creates a task instance from the specified task template.
createInputMessage Creates an input message for the specified task template. For example, create a message that can be used to start a task.
queryTaskTemplates Retrieves task templates that are stored in the database.

Task instances

The following methods are available to work with task instances.

Table 2. API methods for task instances
Method Description
getTask Retrieves a task instance; the task instance can be in any state.
startTask Starts a task that has already been created.
resume Resumes the human or participating task.
suspend Suspends the human or participating task.
terminate Terminates the specified task instance. If an originating task is terminated, this action has no impact on the invoked service.
delete Deletes the specified task instance.

Escalations

The following methods are available to work with escalations.

Table 3. API methods for working with escalations
Method Description
getEscalation Retrieves the specified escalation instance.

Variables and custom properties

The interface provides a get and a set method to retrieve and set values for variables. You can also associate named properties with, and retrieve named properties from task instances. Custom property names and values must be of the java.lang.String type.

Table 4. API methods for variables and custom properties
Method Description
getCustomProperty Retrieves the named custom property of the specified task instance.
getCustomProperties Retrieves the named custom properties of the specified task instance.
getCustomPropertyNames Retrieves the names of the custom properties for the task instance.
setCustomProperty Stores custom-specific values for the specified task instance.
Related reference
Allowed actions for tasks
Related information
Deprecated features

Terms of use | | Broken links

Last updated: Tue Dec 06 04:14:40 2005

(c) Copyright IBM Corporation 2005.
This information center is powered by Eclipse technology (http://www.eclipse.org)