Class: TaskAPI

TaskAPI

A TaskAPI control provides the following configuration properties in Process Designer:
Behavior
Data Retrieval Mode: {All Details | Data Only | Available Actions | None} string
Events
On Load:
Description: This event when the control is loaded.
Example:
On Request Complete:
Description: This event fires whenever a request is completed successfully.
Example: 
${TaskUIFrame}.loadTask(me.getTaskId());
On Request Error:
Description: This event is fired when a request error is detected.
Example: 
console.log(me.getResult());

new TaskAPI()

AWM-Control-TaskAPI.js, line 7
This constructor is never used explicitly.

Extends

  • com.ibm.bpm.coach.CoachView

Methods

assignBack()

AWM-Control-TaskAPI.js, line 392
Assigns the task back to the original owner.

assignToGroup(group)

AWM-Control-TaskAPI.js, line 355
Assign the task to a group
Name Type Description
group string the name of the group to which the task should be assigned.

assignToMe()

AWM-Control-TaskAPI.js, line 374
Assigns the task to the individual that is running the instance.

assignToUser(user)

AWM-Control-TaskAPI.js, line 336
Assign the task to a user
Name Type Description
user string the name of the user

cancel(date)

AWM-Control-TaskAPI.js, line 459
Programmatically cancels the task
Name Type Description
date string due date is formatted in ISO-8601 format (e.g. 2011-01-05T03:15:30.000-00:00)

finish(data)

AWM-Control-TaskAPI.js, line 476
Mark the task as finished
Name Type Description
data string the passed in data

getBusinessData(asList){object}

AWM-Control-TaskAPI.js, line 281
Gets the business data for the control
Name Type Description
asList boolean whether to return as a list or not
Returns:
Type Description
object

getLastAction(){string}

AWM-Control-TaskAPI.js, line 538
Gets the last type of request made
Returns:
Type Description
string

getResult(){object}

AWM-Control-TaskAPI.js, line 269
Gets the data of task(s)
Returns:
Type Description
object

getTaskId(){integer}

AWM-Control-TaskAPI.js, line 526
Gets the task ID
Returns:
Type Description
integer

getType(){string}

AWM-Control-TaskAPI.js, line 550
Gets the type of the control
Returns:
Type Description
string

refresh()

AWM-Control-TaskAPI.js, line 495
Refreshes the task to view changes and updates made

setBusinessData(data)

AWM-Control-TaskAPI.js, line 302
Sets the business data for the control
Name Type Description
data string the data for the business data, note: data is a string which must be in JSON format

setTaskId(taskId, refresh)

AWM-Control-TaskAPI.js, line 511
Sets the task ID
Name Type Description
taskId integer the assigned task ID
refresh boolean whether or not to refresh

start()

AWM-Control-TaskAPI.js, line 320
Programmatically start the control

updateDueDate(date)

AWM-Control-TaskAPI.js, line 436
Updates the due date of the task
Name Type Description
date string due date is formatted in ISO-8601 format (e.g. 2011-01-05T03:15:30.000-00:00)

updatePriority(priority)

AWM-Control-TaskAPI.js, line 410
Updates the priority of the task.
Name Type Description
priority string Highest/10 | High/20 | Normal/30 | Low/40 | Lowest/50
Example
${TaskAPI}.updatePriority("10"); //sets the current tasks priority to "Highest"