| Package | lc.core |
| Interface | public interface ITaskManager |
ITaskManager interface contains methods
and properties to retrieve and manage tasks. In general,
this interface is used for retrieving and searching for tasks because
most other operations should operate on the Task object
(for example, use task.complete() instead of
ITaskManager.complete(taskId)).
See also
| Method | Defined By | ||
|---|---|---|---|
|
Abandons the task identified by the task identifier.
| ITaskManager | ||
|
Adds an attachment to a task item.
| ITaskManager | ||
|
addNote(taskId:String, title:String, note:String, attachmentPermissions:AttachmentPermissions):ObjectToken
Adds a note to a task item.
| ITaskManager | ||
|
Claim the task from another user or group.
| ITaskManager | ||
|
Completes task item.
| ITaskManager | ||
|
Consults with another user with regards to the specified task.
| ITaskManager | ||
|
Deletes an attachment or note from a task item.
| ITaskManager | ||
|
Returns the tasks returned from a search request using the provided search filter.
| ITaskManager | ||
|
Forwards the task identified, by the task identifier, to another user.
| ITaskManager | ||
|
Retrieves the collection of Assignment objects that are associated with a task identifier.
| ITaskManager | ||
|
Retrieves the collection of attachments and notes that are associated with a task.
| ITaskManager | ||
|
Retrieves an extended note.
| ITaskManager | ||
|
Retrieves the data for a task item.
| ITaskManager | ||
|
Retrieves the collection of pending tasks that are associated with the process instance identifier.
| ITaskManager | ||
|
Retrieves a collection of process variable definitions for a given task that
the user has participated in.
| ITaskManager | ||
|
Retrieves a specific search template.
| ITaskManager | ||
|
Retrieves a collection of search template descriptors.
| ITaskManager | ||
|
Retrieves an attachment document for a task item.
| ITaskManager | ||
|
Retrieves the task that is associated with the task identifier.
| ITaskManager | ||
|
Retrieves the location, as a URL, of an image for a task.
| ITaskManager | ||
|
Retrieves all the tasks that a user has access to.
| ITaskManager | ||
|
Retrieves the collection of tasks that are associated with the process instance identifier.
| ITaskManager | ||
|
Locks the task and prevents other users from claiming the task.
| ITaskManager | ||
|
Rejects the task.
| ITaskManager | ||
|
Retrieves a form for a task.
| ITaskManager | ||
|
Saves the task item data to the server.
| ITaskManager | ||
|
Sets the visibility of a task.
| ITaskManager | ||
|
Shares a task with another user.
| ITaskManager | ||
|
Submits task item data to the server.
| ITaskManager | ||
|
submitItemWithPriorData(taskId:String, taskItemIndex:int, dataKey:Object, params:Object = null):ObjectToken
Submits task item data to the server.
| ITaskManager | ||
|
Unlocks the task and releases the task to allow other
users to claim the task provided they have access to the task.
| ITaskManager | ||
|
Updates an attachment to a task item.
| ITaskManager | ||
| abandon | () | method |
public function abandon(taskId:String):Token
Abandons the task identified by the task identifier.
Parameters
taskId:String — Specifies the task identifier.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| addAttachment | () | method |
public function addAttachment(taskId:String, file:FileReference, attachmentPermissions:AttachmentPermissions):Token
Adds an attachment to a task item.
Parameters
taskId:String — Specifies the identifier of the task to reject.
|
|
file:FileReference — Specifies the FileReference object for the attachment.
|
|
attachmentPermissions:AttachmentPermissions — Specifies the permissions for the attachment.
|
Token — A token used to set result and fault handlers to be called when the
operation has completed.
|
| addNote | () | method |
public function addNote(taskId:String, title:String, note:String, attachmentPermissions:AttachmentPermissions):ObjectToken
Adds a note to a task item.
Parameters
taskId:String — Specifies the task identifier.
|
|
title:String — Specifies the title for the note.
|
|
note:String — Specifies the note text.
|
|
attachmentPermissions:AttachmentPermissions — Specifies the permissions for the attachment.
|
ObjectToken — A token that will contain an AttachmentInfo object when the request completes.
You can set result and fault handlers on the token to be called when the invocation is complete and the result is returned.
|
| claim | () | method |
public function claim(taskId:String, lockTask:Boolean):Token
Claim the task from another user or group.
Parameters
taskId:String — Specifies the task identifier.
|
|
lockTask:Boolean — Specifies whether to claim and lock a task. If a value
of true is provided, the task will be both locked and claimed.
If a value of false is provided, the task will be claimed but not
locked.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| complete | () | method |
public function complete(taskId:String, routeName:String = null):Token
Completes task item.
Parameters
taskId:String — Specifies the task identifier.
|
|
routeName:String (default = null) |
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| consult | () | method |
public function consult(taskId:String, userOid:String):Token
Consults with another user with regards to the specified task.
Parameters
taskId:String — Specifies the task identifier.
|
|
userOid:String — Specifies the OID of the person to consult with.
|
Token — A token used to set result and fault handlers to be called when
the operation has completed.
|
| deleteAttachment | () | method |
public function deleteAttachment(taskId:String, attachmentId:String):Token
Deletes an attachment or note from a task item.
Parameters
taskId:String — Specifies the task identifier.
|
|
attachmentId:String — Specifies the attachment to be deleted.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| findTasks | () | method |
public function findTasks(searchFilter:SearchFilter):CollectionToken
Returns the tasks returned from a search request using the provided search filter.
Parameters
searchFilter:SearchFilter — The search criteria to filter the results. It also contains a list of the fields
that must be returned and up to two fields that the results are to be sorted with.
|
CollectionToken — A token containing the task collection. The collection may not be populated yet.
You can set result and fault handlers on the token to be called when the collection has
been fully populated. The result collection will contain Task objects.
|
| forward | () | method |
public function forward(taskId:String, userOid:String):Token
Forwards the task identified, by the task identifier, to another user.
Parameters
taskId:String — Specifies the task identifier.
|
|
userOid:String — - The user's OID of the person to forward the task to.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| getAssignmentsForTask | () | method |
public function getAssignmentsForTask(taskId:String):CollectionToken
Retrieves the collection of Assignment objects that are associated with a task identifier.
Parameters
taskId:String — Specifies the identifier of the task.
|
CollectionToken — A token containing a collection of Assignment objects when the request
completes. You can set result and fault handlers on the token to be called when
the invocation is complete and the collection is fully populated.
|
| getAttachments | () | method |
public function getAttachments(taskId:String):CollectionToken
Retrieves the collection of attachments and notes that are associated with a task.
Parameters
taskId:String — Specifies the task identifier.
|
CollectionToken — A token containing a collection of Attachment objects.
You can set result and fault handlers on the token to be called when it is
fully populated.
|
| getExtendedNote | () | method |
public function getExtendedNote(taskId:String, noteId:String):Token
Retrieves an extended note.
Parameters
taskId:String — Specifies the task identifier.
|
|
noteId:String — Specifies the attachment identifier.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| getItemData | () | method |
public function getItemData(taskId:String, taskItemIndex:int):ObjectToken
Retrieves the data for a task item. Note that the item
retrieved using the renderItem method may already contain merged data.
Parameters
taskId:String — Specifies the task identifier.
|
|
taskItemIndex:int — Specifies the task item to be returned.
|
ObjectToken — A token that will contain a TaskItemResult object when
the request completes. You can set result and fault handlers on the token
to be called when the invocation is complete and the result is returned.
The returned object will be of type XML if the data is XML; otherwise, it
will be of type ByteArray.
|
| getPendingTasksForProcess | () | method |
public function getPendingTasksForProcess(processId:Number):CollectionToken
Retrieves the collection of pending tasks that are associated with the process instance identifier.
Parameters
processId:Number — Specifies the process instance identifier which to obtain the task for.
|
CollectionToken — A token containing a collection of Task objects when the
request completes. You can set result and fault handlers on the token to be
called when the invocation is complete and the collection is fully populated.
|
| getProcessVariablesForTask | () | method |
public function getProcessVariablesForTask(taskId:String):CollectionToken
Retrieves a collection of process variable definitions for a given task that the user has participated in.
Parameters
taskId:String — Specifies the task identifier.
|
CollectionToken — A token containing a collection of ProcessVariable objects
when the request completes. You can set result and fault handlers on the token
to be called when the invocation is complete and the collection is fully populated.
|
| getSearchTemplate | () | method |
public function getSearchTemplate(searchTemplateId:Number):ObjectToken
Retrieves a specific search template.
Parameters
searchTemplateId:Number — Specifies the unique identifier of the search template.
|
ObjectToken — A token that will contain a SearchTemplate object (as XML) when
the request completes. You can set result and fault handlers on the token
to be called when the invocation is complete and the result is returned.
|
| getSearchTemplateDescriptors | () | method |
public function getSearchTemplateDescriptors():CollectionToken
Retrieves a collection of search template descriptors.
ReturnsCollectionToken — A token containing a collection of SearchTemplateDescriptor
objects when the request completes. You can set result and fault handlers on the
token to be called when the invocation is complete and the collection
is fully populated.
|
| getTaskAttachmentDocument | () | method |
public function getTaskAttachmentDocument(taskId:String, attachmentId:String):ObjectToken
Retrieves an attachment document for a task item. The document URL should be used once only.
Parameters
taskId:String — Specifies the task identifier.
|
|
attachmentId:String — Specifies the attachment identifier.
|
ObjectToken — A token that will contain the attachment document when the
request completes. You can set result and fault handlers on the token
to be called when the invocation is complete and the result is returned.
The returned object will be of type XML if the data is XML;
otherwise, it will be of type ByteArray.
|
| getTaskById | () | method |
public function getTaskById(taskId:String):ObjectToken
Retrieves the task that is associated with the task identifier.
Parameters
taskId:String — Specifies the task identifier to obtain the task for.
|
ObjectToken — A token containing the task when the request completes. You can set result and fault handlers on the token to be called when the invocation is complete.
|
| getTaskImageUrl | () | method |
public function getTaskImageUrl(taskId:String, imageTicket:String):String
Retrieves the location, as a URL, of an image for a task.
Parameters
taskId:String — Specifies the task identifier for which to obtain the image.
|
|
imageTicket:String — Specifies the location of the image associated with the task.
|
String — A URL from which the image can be retrieved.
|
| getTasks | () | method |
public function getTasks():CollectionToken
Retrieves all the tasks that a user has access to.
ReturnsCollectionToken — A token containing the task collection. The collection may not be populated yet.
You can set result and fault handlers on the token to be called when the collection
is fully populated. The result collection will contain Task objects.
|
| getTasksForProcess | () | method |
public function getTasksForProcess(processId:Number):CollectionToken
Retrieves the collection of tasks that are associated with the process instance identifier.
Parameters
processId:Number — Specifies the process instance identifier to obtain the task for.
|
CollectionToken — A token containing a collection of Task objects when the request completes.
You can set result and fault handlers on the token to be called when the
invocation is complete and the collection is fully populated.
|
| lock | () | method |
public function lock(taskId:String):Token
Locks the task and prevents other users from claiming the task.
Parameters
taskId:String — Specifies the identifier of the task to lock.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| reject | () | method |
public function reject(taskId:String):Token
Rejects the task. This will cause the task to return to the previous assigned user.
Parameters
taskId:String — Specifies the identifier of the task to reject.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| renderItem | () | method |
public function renderItem(taskId:String, taskItemIndex:int, params:Object = null):ObjectToken
Retrieves a form for a task.
Parameters
taskId:String — Specifies the task identifier.
|
|
taskItemIndex:int — Reserved for future use.
|
|
params:Object (default = null) |
ObjectToken — A token that will contain a TaskItemResult object when the request completes.
You can set result and fault handlers on the token to be called when the invocation
is complete and the result is returned.
|
| saveItemData | () | method |
public function saveItemData(taskId:String, taskItemIndex:int, data:Object):Token
Saves the task item data to the server.
Parameters
taskId:String — Specifies the task identifier.
|
|
taskItemIndex:int — Reserved for future use.
|
|
data:Object — Specifies the data to be saved. Must be of type XML or ByteArray.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| setVisible | () | method |
public function setVisible(taskId:String, visible:Boolean):Token
Sets the visibility of a task. Setting visible to false will set the task's
visible flag to false. Setting visible to true will set the
task's visible flag to true.
Parameters
taskId:String — Specifies the task identifier.
|
|
visible:Boolean |
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| share | () | method |
public function share(taskId:String, userOid:String):Token
Shares a task with another user.
Parameters
taskId:String — Specifies the task identifier.
|
|
userOid:String — Specifies the OID of the person to share the task with.
|
Token — A token used to set result and fault handlers to be called when
the operation has completed.
|
| submitItemWithData | () | method |
public function submitItemWithData(taskId:String, taskItemIndex:int, data:Object, params:Object = null):ObjectToken
Submits task item data to the server.
Parameters
taskId:String — Specifies the task identifier.
|
|
taskItemIndex:int — Specifies the data to be submitted.
|
|
data:Object — Reserved for future use.
|
|
params:Object (default = null) |
ObjectToken — A token that will contain a TaskItemResult when the request completes.
You can set result and fault handlers on the token to be called when the
invocation is complete and the result is returned.
|
| submitItemWithPriorData | () | method |
public function submitItemWithPriorData(taskId:String, taskItemIndex:int, dataKey:Object, params:Object = null):ObjectToken
Submits task item data to the server.
Parameters
taskId:String — Specifies the task identifier.
|
|
taskItemIndex:int — Reserved for future use.
|
|
dataKey:Object — Specifies the unique key to look up data in session.
|
|
params:Object (default = null) |
ObjectToken — A token that will contain a TaskItemResult object when the request completes.
You can set result and fault handlers on the token to be called when the invocation is
complete and the result is returned.
|
| unlock | () | method |
public function unlock(taskId:String):Token
Unlocks the task and releases the task to allow other users to claim the task provided they have access to the task.
Parameters
taskId:String — Specifies the task identifier.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| updateAttachment | () | method |
public function updateAttachment(taskId:String, attachmentId:String, file:FileReference):Token
Updates an attachment to a task item.
Parameters
taskId:String — Specifies the task identifier.
|
|
attachmentId:String — Specifies the identifier for the attachment.
|
|
file:FileReference — Specifies the FileReference object for the attachment.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/core/ITaskManager.html