Worklist Control Annotations

This section includes information on Task control and Task Worker control annotations.

These annotations along with their attributes determine the default behavior of the Worklist controls. The Task and Task Worker controls may be configured during their lifetimes by calling methods in the TaskControl and TaskWorkerControl classes. The information contained in the annotations include the following:

• The object type that you must create to pass or return from methods at run time.
• The object type on which you must base the formatting of the text or the specified java.lang.String value you provide.
• All worklist annotation tags can receive string values in the format of the relevant object type.
• Some annotations accept enumerations, limited to a choice of defined values.
• Each annotation specifies which Task or Task Worker control it uses.
• Values that may be arrays show the base class with a suffix of [], for example, String[].

Topics Included in This Section

@jc: advanced Annotation

Notations for advanced options.

@jc:assignee Annotation

Assigns user and groups to Tasks.

@jc:select Annotation

Accepts values to search for Tasks, including TaskSelector objects, and returns a set of Task IDs.

@jc:task Annotation

Assigns a Task to the Assignees List.

@jc:task-abort Annotation

Change the state of a task to ABORTED.

@jc:task-assign Annotation

Assigns a Task to the Assignees List.

@jc:task-claim Annotation

Sets a default user as having put a Task in a claimed state, as a claimant.

@jc:task-complete Annotation

Creates Worklist control methods that place Tasks in a completed state.

@jc:task-create Annotation

Creates Tasks.

@jc:task-delete Annotation

Creates Worklist control methods that delete Tasks.

@jc:task-event Annotation

Provides Task information for implementing callback method interfaces.

@jc:task-get-info Annotation

Creates Worklist control methods that return information from Tasks.

@jc:task-get-property Annotation

Creates methods that return the value of a Task property as a String.

@jc:task-get-property-name Annotation

Creates Worklist control methods that return Task property names.

@jc:task-get-request Annotation

Creates Worklist control methods that return Task request data.

@jc:task-get-response Annotation

Creates Worklist control methods that return Task response data.

@jc:task-remove-property Annotation

Remove properties with the name you specify from Tasks.

@jc:task-resume Annotation

Creates Worklist control methods that remove Tasks from a suspended state.

@jc:task-return Annotation

Create Worklist control methods that place Tasks in an assigned state using the original Assignees List.

@jc:task-set-property Annotation

Sets the value of a single Task property.

@jc:task-start Annotation

Creates Worklist control methods that place Tasks in a started state.

@jc:task-stop Annotation

Creates Worklist control methods that change Tasks from started to claimed states.

@jc:task-suspend Annotation

Creates Worklist control methods that place Tasks in a suspended state.

@jc:task-update Annotation

Updates one or more Task properties at a time for a method.

@jc:task-worker Annotation

Specifies that the control is a Task Worker control.

Related Topics

TaskControl Interface

Worklist Controls