| Package | lc.domain |
| Class | public class Task |
| Inheritance | Task  EventDispatcher Object |
| Implements | IWorkspaceManaged |
Task class represents a task in LiveCycle ES. You would use
the Task class for the following reasons:
| Property | Defined By | ||
|---|---|---|---|
| assignments : ListCollectionView
The collection of Assignment objects for the task.
| Task | ||
| attachments : ListCollectionView
[read-only]
A collection of Attachment objects for the task.
| Task | ||
| completeTime : Date
The date and time that the task completed.
| Task | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| consultGroupId : String
The group identifier that may be used when the consult operation is performed.
| Task | ||
| createTime : Date
The date and time that the task was created.
| Task | ||
| currentAssignment : Assignment
The current assignment for the task.
| Task | ||
| deadline : Date
The date and time the task will be deadlined.
| Task | ||
| description : String
The task description.
| Task | ||
| forwardGroupId : String
The group identifier that may be used when the forward operation is performed.
| Task | ||
| instructions : String
The task instructions.
| Task | ||
| isDeadlined : Boolean = false
A flag that indicates whether the task has been deadlined.
| Task | ||
| isDraft : Boolean = false
A flag that indicates whether the task has been saved as a draft.
| Task | ||
| isInitalTask : Boolean = false
A flag that indicates whether the task has just been created from an endpoint.
| Task | ||
| isLocked : Boolean
A flag that indicates whether the task is locked.
| Task | ||
| isRouteSelectionRequired : Boolean
A flag that indicates whether a route selection is required.
| Task | ||
| isShowAttachments : Boolean
A flag that indicates whether the attachments should be available to the user.
| Task | ||
| isStartTask : Boolean
A flag that indicates whether this is a newly started task.
| Task | ||
| nextReminder : Date
The date and time the next reminder will trigger.
| Task | ||
| numForms : Number
The number of forms on the task.
| Task | ||
| numFormsToBeSaved : Number
The number of forms to be saved on the task.
| Task | ||
| priority : Number
The task's priority.
| Task | ||
| processInstance : ProcessInstance
The process instance that owns this task.
| Task | ||
| processInstanceId : Number
The identifier of the process instance object that owns this task.
| Task | ||
| processInstanceStatus : Number
The process instance's status.
| Task | ||
| processVariables : ListCollectionView
A collection of ProcessVariable objects that are related to this task.
| Task | ||
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| reminderCount : Number
The number of reminders that have been issued for this task.
| Task | ||
| routeList : Array
An array of route names available for this task.
| Task | ||
| selectedRoute : String
The selected route.
| Task | ||
| serviceName : String
The name of the service.
| Task | ||
| session : SessionMap
[read-only]
A SessionMap object that stores information relating to the server session.
| Task | ||
| status : Number
The task status.
| Task | ||
| stepName : String
The name of the step.
| Task | ||
| taskACL : TaskACL
The access control list for a task.
| Task | ||
| taskId : String
The task identifier.
| Task | ||
| updateTime : Date
The date and time of the last update.
| Task | ||
| Method | Defined By | ||
|---|---|---|---|
|
Abandons the task.
| Task | ||
|
Adds an attachment to the task.
| Task | ||
|
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.
| EventDispatcher | |
|
Adds a note to the task.
| Task | ||
|
Retrieves a list of TaskCommand objects that are available for execution on the task.
| Task | ||
|
Claims the task from another user or group.
| Task | ||
|
Completes the task.
| Task | ||
|
Consults with another user with regards to the task.
| Task | ||
|
Deletes the attachment from the task.
| Task | ||
|
Dispatches an event into the event flow.
| EventDispatcher | |
|
Forwards the task to another user.
| Task | ||
|
Retrieves the attachment document from the task.
| Task | ||
|
Retrieves an extended note.
| Task | ||
|
Retrieves the data for a task item.
| Task | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
|
Indicates whether an object has a specified property defined.
| Object | |
|
Indicates whther you are the owner of the task.
| Task | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
|
Loads the assignments for the task.
| Task | ||
|
Loads the atachments for the task.
| Task | ||
|
Loads the process instance for this task.
| Task | ||
|
Loads the process variables for this task.
| Task | ||
|
Locks the task preventing other users from claiming the task.
| Task | ||
|
Indicates whether the specified property exists and is enumerable.
| Object | |
|
Rejects the task, which will return the task to the previous assigned user.
| Task | ||
|
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
|
Retrieves a form for a task.
| Task | ||
|
Retrieves a collection of CompleteCommand objects, with one entry for each route.
| Task | ||
|
Saves task item data to the server.
| Task | ||
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Sets the SessionMap object, which stores the information relating to the
server session.
| Task | ||
|
Specifies the visibility of a task.
| Task | ||
|
Shares the task with another user.
| Task | ||
|
Submits task item data to the server.
| Task | ||
|
Submits task item data to the server.
| Task | ||
|
Returns the string representation of the specified object.
| Object | |
|
Unlocks the task, which releases the task to allow other
users to claim the task if they have access to the task.
| Task | ||
|
Updates the attachment document.
| Task | ||
|
Returns the primitive value of the specified object.
| Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| assignments | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var assignments:ListCollectionView
The collection of Assignment objects for the task. The
assignments property is not valid until the loadAssignments
method has been executed.
See also
| attachments | property |
attachments:ListCollectionView [read-only]
A collection of Attachment objects for the task.
public function get attachments():ListCollectionView
| completeTime | property |
completeTime:Date [read-write] The date and time that the task completed.
public function get completeTime():Date
public function set completeTime(value:Date):void
| consultGroupId | property |
consultGroupId:String [read-write] The group identifier that may be used when the consult operation is performed.
public function get consultGroupId():String
public function set consultGroupId(value:String):void
See also
| createTime | property |
createTime:Date [read-write] The date and time that the task was created.
public function get createTime():Date
public function set createTime(value:Date):void
| currentAssignment | property |
currentAssignment:Assignment [read-write] The current assignment for the task.
public function get currentAssignment():Assignment
public function set currentAssignment(value:Assignment):void
See also
| deadline | property |
deadline:Date [read-write] The date and time the task will be deadlined.
public function get deadline():Date
public function set deadline(value:Date):void
| description | property |
description:String [read-write] The task description.
public function get description():String
public function set description(value:String):void
| forwardGroupId | property |
forwardGroupId:String [read-write] The group identifier that may be used when the forward operation is performed.
public function get forwardGroupId():String
public function set forwardGroupId(value:String):void
See also
| instructions | property |
instructions:String [read-write] The task instructions.
public function get instructions():String
public function set instructions(value:String):void
| isDeadlined | property |
public var isDeadlined:Boolean = false
A flag that indicates whether the task has been deadlined. A deadlined task
can no longer be completed and must be abandoned.
The default value is false.
| isDraft | property |
public var isDraft:Boolean = false
A flag that indicates whether the task has been saved as a draft.
The default value is false.
| isInitalTask | property |
public var isInitalTask:Boolean = false
A flag that indicates whether the task has just been created from an endpoint. The
process instance is not yet created for an initial task. It is possible for an
initial task to still be forwarded to another user.
The default value is false.
| isLocked | property |
isLocked:Boolean [read-write]
A flag that indicates whether the task is locked.
A value of true indicates that the task is locked.
public function get isLocked():Boolean
public function set isLocked(value:Boolean):void
| isRouteSelectionRequired | property |
isRouteSelectionRequired:Boolean [read-write]
A flag that indicates whether a route selection is required.
A value of true indicates that route selection is required.
public function get isRouteSelectionRequired():Boolean
public function set isRouteSelectionRequired(value:Boolean):void
| isShowAttachments | property |
isShowAttachments:Boolean [read-write]
A flag that indicates whether the attachments should be available to the user.
A value of true indicates that attachments should be available
to the user.
public function get isShowAttachments():Boolean
public function set isShowAttachments(value:Boolean):void
| isStartTask | property |
isStartTask:Boolean [read-write]
A flag that indicates whether this is a newly started task.
A value of true indicates that this is a newly started task.
public function get isStartTask():Boolean
public function set isStartTask(value:Boolean):void
| nextReminder | property |
nextReminder:Date [read-write] The date and time the next reminder will trigger.
public function get nextReminder():Date
public function set nextReminder(value:Date):void
| numForms | property |
numForms:Number [read-write] The number of forms on the task.
public function get numForms():Number
public function set numForms(value:Number):void
| numFormsToBeSaved | property |
numFormsToBeSaved:Number [read-write] The number of forms to be saved on the task.
public function get numFormsToBeSaved():Number
public function set numFormsToBeSaved(value:Number):void
| priority | property |
priority:Number [read-write]
The task's priority. It may be a value of the constants
defined in the TaskConstants class.
public function get priority():Number
public function set priority(value:Number):void
See also
| processInstance | property |
processInstance:ProcessInstance [read-write]
The process instance that owns this task. This property is
not valid until the loadProcessInstance method has been called.
public function get processInstance():ProcessInstance
public function set processInstance(value:ProcessInstance):void
See also
| processInstanceId | property |
processInstanceId:Number [read-write] The identifier of the process instance object that owns this task. This will be used to load the process instance object.
public function get processInstanceId():Number
public function set processInstanceId(value:Number):void
See also
| processInstanceStatus | property |
processInstanceStatus:Number [read-write] The process instance's status.
The process instance's status value is a localized
String value that is processed by looking the numeric value up in
the resource bundle.
public function get processInstanceStatus():Number
public function set processInstanceStatus(value:Number):void
See also
| processVariables | property |
processVariables:ListCollectionView [read-write]
A collection of ProcessVariable objects that are related to this task.
public function get processVariables():ListCollectionView
public function set processVariables(value:ListCollectionView):void
See also
| reminderCount | property |
reminderCount:Number [read-write] The number of reminders that have been issued for this task.
public function get reminderCount():Number
public function set reminderCount(value:Number):void
| routeList | property |
routeList:Array [read-write] An array of route names available for this task.
public function get routeList():Array
public function set routeList(value:Array):void
| selectedRoute | property |
selectedRoute:String [read-write] The selected route. This is used when a form is completed.
public function get selectedRoute():String
public function set selectedRoute(value:String):void
See also
| serviceName | property |
serviceName:String [read-write] The name of the service.
public function get serviceName():String
public function set serviceName(value:String):void
| session | property |
session:SessionMap [read-only]
A SessionMap object that stores information relating to the server session.
public function get session():SessionMap
| status | property |
status:Number [read-write]
The task status. It may be one of the constants
defined in the TaskConstants class.
public function get status():Number
public function set status(value:Number):void
See also
| stepName | property |
stepName:String [read-write] The name of the step.
public function get stepName():String
public function set stepName(value:String):void
| taskACL | property |
taskACL:TaskACL [read-write] The access control list for a task.
public function get taskACL():TaskACL
public function set taskACL(value:TaskACL):void
See also
| taskId | property |
taskId:String [read-write] The task identifier.
public function get taskId():String
public function set taskId(value:String):void
| updateTime | property |
updateTime:Date [read-write] The date and time of the last update.
public function get updateTime():Date
public function set updateTime(value:Date):void
| abandon | () | method |
public function abandon():Token
Abandons the task.
ReturnsToken — A token used to set result and fault handlers to be called when the operation has completed.
|
| addAttachment | () | method |
public function addAttachment(attachment:FileReference, permissions:AttachmentPermissions):Token
Adds an attachment to the task.
Parameters
attachment:FileReference — Specifies the FileReference object to be attached.
|
|
permissions:AttachmentPermissions — Specifies the permissions to use for the attachment.
|
Token — A token that represents the task where the attachment was added.
|
| addNote | () | method |
public function addNote(title:String, note:String, permissions:AttachmentPermissions):ObjectToken
Adds a note to the task.
Parameters
title:String — Specifies the title of the note.
|
|
note:String — Specifies the note content.
|
|
permissions:AttachmentPermissions — Specifies the permissions to use for the attachment.
|
ObjectToken — A token that represents the task to which the note was added.
|
| availableCommands | () | method |
public function availableCommands():ArrayCollection
Retrieves a list of TaskCommand objects that are available for execution on the task.
The available commands are also known as action commands and typically operate on the task without
completing it. The CompleteCommand object is considered an action command
if it does not have an associated route.
ArrayCollection — A collection of action commands for a task.
|
| claim | () | method |
public function claim(lock:Boolean):Token
Claims the task from another user or group.
Parameters
lock:Boolean — Specifies whether the task will be claimed and locked,
If a value of true is specified, it will be claimed and locked; a value of false
specifies that the task is 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():Token
Completes the task. The selectedRoute property is used
if it was supplied to the task.
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| consult | () | method |
public function consult(userOid:String):Token
Consults with another user with regards to the task.
Parameters
userOid:String — Specifes the OID of the person to which to consult the task.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| deleteAttachment | () | method |
public function deleteAttachment(attachmentId:String):Token
Deletes the attachment from the task.
Parameters
attachmentId:String — Specifies the identifier of the attachment to delete.
|
Token — A token that can be used by the caller to specify handlers for this asynchronous call.
|
| forward | () | method |
public function forward(userOid:String):Token
Forwards the task to another user.
Parameters
userOid:String — Specifies the OID of the person to which to forward the task.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| getAttachmentDocument | () | method |
public function getAttachmentDocument(attachmentId:String):ObjectToken
Retrieves the attachment document from the task.
Parameters
attachmentId:String — Specifies the identifier of the attachment to be retrieved.
|
ObjectToken — A token that will contain a DocumentReference object,
and which can be used by the caller to specify handlers for this asynchronous call.
|
See also
| getExtendedNote | () | method |
public function getExtendedNote(id:String):Token
Retrieves an extended note.
Parameters
id:String — Specifies the note identifier.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| getItemData | () | method |
public function getItemData(taskItemIndex:int):ObjectToken
Retrieves the data for a task item. Note that the item retrieved through renderItem may already contain merged data.
Parameters
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 has been returned. The returned object will be of type XML if the data is XML; otherwise it will be of type ByteArray.
|
| isOwner | () | method |
public function isOwner():Boolean
Indicates whther you are the owner of the task. To be the owner, the principal identifier of the task access control list (ACL) must be the same as that of the caller's object identifer (OID).
ReturnsBoolean |
| loadAssignments | () | method |
public function loadAssignments(forceLoad:Boolean = false):Token
Loads the assignments for the task. The assignments property is not
valid until this method has been executed.
Parameters
forceLoad:Boolean (default = false)true is provided.
|
Token — A token that can be used by the caller to specify handlers for this asynchronous call.
|
See also
| loadAttachments | () | method |
public function loadAttachments(forceLoad:Boolean = false):Token
Loads the atachments for the task.
Parameters
forceLoad:Boolean (default = false)true is provided.
|
Token — A token that can be used by the caller to specify handlers
for this asynchronous call.
|
| loadProcessInstance | () | method |
public function loadProcessInstance():Token
Loads the process instance for this task.
ReturnsToken — A token that can be used by the caller to specify handlers for this asynchronous call.
|
| loadProcessVariables | () | method |
public function loadProcessVariables():Token
Loads the process variables for this task.
ReturnsToken — A token that can be used by the caller to specify handlers for this asynchronous call.
|
| lock | () | method |
public function lock():Token
Locks the task preventing other users from claiming the task.
ReturnsToken — A token used to set result and fault handlers to be called when the operation has completed.
|
| reject | () | method |
public function reject():Token
Rejects the task, which will return the task to the previous assigned user.
ReturnsToken — A token used to set result and fault handlers to be called when the operation has completed.
|
| renderItem | () | method |
public function renderItem(taskItemIndex:int, params:Object = null):ObjectToken
Retrieves a form for a task.
Parameters
taskItemIndex:int — Reserved for future use.
|
|
params:Object (default = null) |
ObjectToken — A token that will contain an 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 has been returned.
|
| routeCommands | () | method |
public function routeCommands():ArrayCollection
Retrieves a collection of CompleteCommand objects, with one entry for each route.
ArrayCollection — A collection of CompleteCommand objects.
|
| saveItemData | () | method |
public function saveItemData(taskItemIndex:int, data:Object):Token
Saves task item data to the server.
Parameters
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.
|
| setSession | () | method |
public function setSession(session:SessionMap):void
Sets the SessionMap object, which stores the information relating to the
server session.
Parameters
session:SessionMap — Specifies the information relating to the server session.
|
| setVisible | () | method |
public function setVisible(visible:Boolean):Token
Specifies the visibility of a task.
Parameters
visible:Boolean — Specifies whether to hide or display the task. A value of true
displays the task.
|
Token — A token used to set result and fault handlers to be called when the operation has completed.
|
| share | () | method |
public function share(userOid:String):Token
Shares the task with another user.
Parameters
userOid:String — Specifies the object identifier 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(taskItemIndex:int, data:Object, params:Object = null):ObjectToken
Submits task item data to the server.
Parameters
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 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 has been returned.
|
| submitItemWithPriorData | () | method |
public function submitItemWithPriorData(taskItemIndex:int, dataKey:Object, params:Object = null):ObjectToken
Submits task item data to the server.
Parameters
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 has been returned.
|
| unlock | () | method |
public function unlock():Token
Unlocks the task, which releases the task to allow other users to claim the task if they have access to the task.
ReturnsToken — A token used to set result and fault handlers to be called when the operation has completed.
|
| updateAttachment | () | method |
public function updateAttachment(attachmentId:String, attachment:FileReference):Token
Updates the attachment document.
Parameters
attachmentId:String — Specifies the identifier of the attachment to be retrieved.
|
|
attachment:FileReference — Specifies the FileReference object containing the attachment with updates.
|
Token — A token that can be used by the caller to specify handlers for this
asynchronous call.
|
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/domain/Task.html