| Package | lc.procmgmt |
| Interface | public interface ITaskManager extends IManager , IEventDispatcher |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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).
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public PropertiesPublic Methods
| Method | Defined By | ||
|---|---|---|---|
Abandons the task identified by the task identifier. | ITaskManager | ||
addAttachment(taskId:String, file:FileReference, attachmentPermissions:AttachmentPermissions):lc.foundation.util:Token
Adds an attachment to a task item. | ITaskManager | ||
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | IEventDispatcher | |
addNote(taskId:String, title:String, note:String, attachmentPermissions:AttachmentPermissions):lc.foundation.util:ObjectToken
Adds a note to a task item. | ITaskManager | ||
Claims the task from another user or group. | ITaskManager | ||
Completes task item. | ITaskManager | ||
Consults with another user about the specified task. | ITaskManager | ||
Deletes an attachment or note from a task item. | ITaskManager | ||
|
Dispatches an event into the event flow. | IEventDispatcher | |
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 | ||
getAllTasksForProcess(processId:Number, includeSubprocessTasks:Boolean):lc.foundation.util:CollectionToken
A new version of the method getTasksForProcess. | 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 | ||
Gets the completion comment of a task. | ITaskManager | ||
Retrieves an extended note. | ITaskManager | ||
Retrieves the location, as a URL, of an image for a task. | 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 participated in. | ITaskManager | ||
Retrieves a specific search template. | ITaskManager | ||
Retrieves a collection of search template descriptors. | ITaskManager | ||
Retrieves the task that is associated with the task identifier. | ITaskManager | ||
Retrieves an attachment document for a task item. | ITaskManager | ||
Retrieves the task that is associated with the task identifier by using a remote object
to the server. | ITaskManager | ||
Deprecated Since LiveCycle ES Update 1 (8.2): Please use lc.procmgmt.ITaskManager.getImageUrlForTask(). | 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 | ||
|
Determines whether the default operation is prevented. | IManager | |
|
Determines whether the default operation is prevented. | IManager | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Locks the task and prevents other users from claiming the task. | ITaskManager | ||
Updates the task id in the session prior to submitting the task
| ITaskManager | ||
Rejects the task. | ITaskManager | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
Retrieves a form for a task. | ITaskManager | ||
Saves the task item data to the server. | ITaskManager | ||
Sets the completion comment of a task. | ITaskManager | ||
Sets the description value of a task. | ITaskManager | ||
Sets the visibility of a task in searches. | ITaskManager | ||
Shares a task with another user. | ITaskManager | ||
submitItemWithData(taskId:String, taskItemIndex:int, data:Object, params:Object = null):lc.foundation.util:ObjectToken
Submits current task item data to the server. | ITaskManager | ||
submitItemWithPriorData(taskId:String, taskItemIndex:int, resultKey:Object, params:Object = null):lc.foundation.util:ObjectToken
Submits task item data that was last saved to the server. | ITaskManager | ||
Unlocks the task to allow other
users to claim the task provided they have access to it. | ITaskManager | ||
Updates an attachment to a task item. | ITaskManager | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Method Detail
abandon | () | method |
public function abandon(taskId:String):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Abandons the task identified by the task identifier.
Parameters
taskId:String — Specifies the task identifier.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is complete.
|
addAttachment | () | method |
public function addAttachment(taskId:String, file:FileReference, attachmentPermissions:AttachmentPermissions):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the
operation is complete.
|
addNote | () | method |
public function addNote(taskId:String, title:String, note:String, attachmentPermissions:AttachmentPermissions):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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.
|
lc.foundation.util: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):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Claims 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 is both locked and claimed.
If a value of false is provided, the task is claimed but not
locked.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is complete.
|
complete | () | method |
public function complete(taskId:String, routeName:String = null):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Completes task item.
Parameters
taskId:String — Specifies the task identifier.
| |
routeName:String (default = null) |
lc.foundation.util:ObjectToken — A token used to set result and fault handlers to be called when the operation is complete.
|
consult | () | method |
public function consult(taskId:String, userOid:String):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Consults with another user about the specified task.
Parameters
taskId:String — Specifies the task identifier.
| |
userOid:String — Specifies the OID of the person to consult with.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when
the operation is complete.
|
deleteAttachment | () | method |
public function deleteAttachment(taskId:String, attachmentId:String):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Deletes an attachment or note from a task item.
Parameters
taskId:String — Specifies the task identifier.
| |
attachmentId:String — Specifies the attachment to be deleted.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is complete.
|
findTasks | () | method |
public function findTasks(searchFilter:SearchFilter):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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 using.
|
lc.foundation.util: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):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Forwards the task identified, by the task identifier to another user.
Parameters
taskId:String — Specifies the task identifier.
| |
userOid:String — The OID of the person to forward the task to.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is complete.
|
getAllTasksForProcess | () | method |
public function getAllTasksForProcess(processId:Number, includeSubprocessTasks:Boolean):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A new version of the method getTasksForProcess. The new feature introduced in getAllTasksForProcess is the capability to specify the return of tasks from subprocesses. Retrieves the collection of tasks that are associated with the process instance identifier.
Parameters
processId:Number — Specifies the identifier of the process instance to obtain the task for.
| |
includeSubprocessTasks:Boolean — Indicator if results should include tasks in sub-processes associated
with the specified process instance.
|
lc.foundation.util: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.
|
getAssignmentsForTask | () | method |
public function getAssignmentsForTask(taskId:String):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves the collection of Assignment objects that are associated with a task identifier.
Parameters
taskId:String — Specifies the identifier of the task.
|
lc.foundation.util: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):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves the collection of attachments and notes that are associated with a task.
Parameters
taskId:String — Specifies the task identifier.
|
lc.foundation.util: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.
|
getCompletionComment | () | method |
public function getCompletionComment(taskId:String):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Gets the completion comment of a task.
Parameters
taskId:String — Specifies the task identifier.
|
lc.foundation.util:ObjectToken — A token containing the completion comment and used to set result and fault handlers to be called when the operation is complete.
|
getExtendedNote | () | method |
public function getExtendedNote(taskId:String, noteId:String):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves an extended note.
Parameters
taskId:String — Specifies the task identifier.
| |
noteId:String — Specifies the attachment identifier.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is complete.
|
getImageUrlForTask | () | method |
public function getImageUrlForTask(task:lc.procmgmt.domain:Task):String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves the location, as a URL, of an image for a task.
Parameters
task:lc.procmgmt.domain:Task — Specifies the task for which to obtain the image URL.
|
String — A URL from which the image can be retrieved.
|
getItemData | () | method |
public function getItemData(taskId:String, taskItemIndex:int):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves the data for a task item. 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.
|
lc.foundation.util: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 is an XML type if the data is XML; otherwise, it
is a ByteArray type.
|
getPendingTasksForProcess | () | method |
public function getPendingTasksForProcess(processId:Number):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves the collection of pending tasks that are associated with the process instance identifier.
Parameters
processId:Number — Specifies the identifier of the process instance to obtain the task for.
|
lc.foundation.util: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):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves a collection of process variable definitions for a given task that the user participated in.
Parameters
taskId:String — Specifies the task identifier.
|
lc.foundation.util: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):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves a specific search template.
Parameters
searchTemplateId:Number — Specifies the unique identifier of the search template.
|
lc.foundation.util: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():lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves a collection of search template descriptors.
Returnslc.foundation.util:CollectionToken — 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.
|
getTask | () | method |
public function getTask(taskId:String):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves the task that is associated with the task identifier. This method uses the
data service getItem method and returns an ObjectToken containing the requested Task.
Parameters
taskId:String — Specifies the task identifier to obtain the task for.
|
lc.foundation.util: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.
|
getTaskAttachmentDocument | () | method |
public function getTaskAttachmentDocument(taskId:String, attachmentId:String):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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.
|
lc.foundation.util: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):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves the task that is associated with the task identifier by using a remote object to the server.
Parameters
taskId:String — Specifies the identifier of the task to obtain.
|
lc.foundation.util: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| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Deprecated Since LiveCycle ES Update 1 (8.2): Please use lc.procmgmt.ITaskManager.getImageUrlForTask().
Retrieves the location, as a URL, of an image for a task.
Parameters
taskId:String — Specifies the identifier of the task for which to obtain the image.
| |
imageTicket:String — Specifies the imageTicket from the task.
|
String — A URL from which the image can be retrieved.
|
Related API Elements
getTasks | () | method |
public function getTasks(refresh:Boolean = false):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves all the tasks that a user has access to.
Parameters
refresh:Boolean (default = false) |
lc.foundation.util: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
is fully populated. The result collection will contain Task objects.
|
getTasksForProcess | () | method |
public function getTasksForProcess(processId:Number):lc.foundation.util:CollectionToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves the collection of tasks that are associated with the process instance identifier.
Parameters
processId:Number — Specifies the identifier of the process instance to obtain the task for.
|
lc.foundation.util: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):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Locks the task and prevents other users from claiming the task.
Parameters
taskId:String — Specifies the identifier of the task to lock.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is complete.
|
prepareForSubmit | () | method |
public function prepareForSubmit(taskId:String):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Updates the task id in the session prior to submitting the task
Parameters
taskId:String — Specifies the task identifier.
|
lc.foundation.util:ObjectToken — A token used to set result and fault handlers to be called when the operation is complete.
You can set result and fault handlers on the token to be called when the invocation is
complete and the result is returned.
|
reject | () | method |
public function reject(taskId:String):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is complete.
|
renderItem | () | method |
public function renderItem(taskId:String, taskItemIndex:int, params:Object = null):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves a form for a task.
Parameters
taskId:String — Specifies the task identifier.
| |
taskItemIndex:int — Reserved for future use.
| |
params:Object (default = null) |
lc.foundation.util: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):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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. The type must be an XML or ByteArray type.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation has completed.
|
setCompletionComment | () | method |
public function setCompletionComment(taskId:String, comment:String):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Sets the completion comment of a task.
Parameters
taskId:String — Specifies the task identifier.
| |
comment:String — Specifies the new comment value.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is complete.
|
setDescription | () | method |
public function setDescription(taskId:String, description:String):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Sets the description value of a task.
Parameters
taskId:String — Specifies the task identifier.
| |
description:String — Specifies the new description value.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is complete.
|
setVisible | () | method |
public function setVisible(taskId:String, visible:Boolean):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Sets the visibility of a task in searches. Setting visible to false
means that the task is not visible in searches. Setting visible to true means that
the task is visible in searches.
Parameters
taskId:String — Specifies the task identifier.
| |
visible:Boolean — Specifies the whether the task is visible in a search.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is complete.
|
share | () | method |
public function share(taskId:String, userOid:String):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when
the operation is complete.
|
submitItemWithData | () | method |
public function submitItemWithData(taskId:String, taskItemIndex:int, data:Object, params:Object = null):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Submits current 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) |
lc.foundation.util: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.
|
submitItemWithPriorData | () | method |
public function submitItemWithPriorData(taskId:String, taskItemIndex:int, resultKey:Object, params:Object = null):lc.foundation.util:ObjectToken| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Submits task item data that was last saved to the server.
Parameters
taskId:String — Specifies the task identifier.
| |
taskItemIndex:int — Reserved for future use.
| |
resultKey:Object — Specifies the unique key to look up data in the current session.
| |
params:Object (default = null) |
lc.foundation.util: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):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Unlocks the task to allow other users to claim the task provided they have access to it.
Parameters
taskId:String — Specifies the task identifier.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is complete.
|
updateAttachment | () | method |
public function updateAttachment(taskId:String, attachmentId:String, file:FileReference):lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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.
|
lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is complete.
|
Examples How to use this example
To retrieve an object that implements the
ITaskManager interface from the current session:
var taskManager:ITaskManager = WorkspaceSession.getTaskManager(session);
Thu Dec 6 2018, 01:12 PM -08:00