Task

Package	lc.procmgmt.domain
Class	public class Task
Inheritance	Task EventDispatcher Object
Implements	IManagedObject, IManaged

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

The Task class represents a task on the Document Server. You use the Task class for the following reasons:

To manage the properties of the task
To perform operations that involve the task
To complete the task, which causes the process instance workflow to go to the next step

For information about using this component to customize Workspace, see Customizing the Adobe Digital Enterprise Platform Document Services - Workspace 10.0 User Interface .

Public Properties

	Property		Defined By
		assignments : ListCollectionView The collection of Assignment objects for the task.	Task
		attachments : ListCollectionView A collection of Attachment objects for the task.	Task
		canInvokeFromStartTask : Boolean [read-only] A flag that indicates whether the task can be used to re-initiate the same TaskManager startpoint that was used to create 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
		isActive : Boolean [read-only] Returns whether the task is active based on the task status.	Task
		isDeadlined : Boolean A flag that indicates whether the task was deadlined.	Task
		isDraft : Boolean A flag that indicates whether the task is saved as a draft.	Task
		isInitalTask : Boolean Deprecated Since LiveCycle ES Update 1 (8.2): Please use isInitialTask.	Task
		isInitialTask : Boolean A flag that indicates whether the task was created from an startpoint.	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 status of the process instance.	Task
		processVariables : ListCollectionView A collection of ProcessVariable objects that are related to this task.	Task
		reminderCount : Number The number of reminders that were 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
		serviceTitle : String The title 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 : lc.procmgmt.domain:TaskACL The access control list for a task.	Task
		taskId : String The task identifier.	Task
		trcVariableName : String The task result collection variable name associated with the task.	Task
		updateTime : Date The date and time of the last update.	Task

Public Methods

	Method		Defined By
		abandon():lc.foundation.util:Token Abandons the task.	Task
		addAttachment(attachment:FileReference, permissions:AttachmentPermissions):lc.foundation.util:Token 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
		addNote(title:String, note:String, permissions:AttachmentPermissions):lc.foundation.util:ObjectToken Adds a note to the task.	Task
		availableCommands():ArrayCollection Retrieves a list of TaskCommand objects that are available for execution on the task.	Task
		claim(lock:Boolean):lc.foundation.util:Token Claims the task from another user or group.	Task
		complete():lc.foundation.util:Token Completes the task.	Task
		consult(userOid:String):lc.foundation.util:Token Consults with another user regarding assigned the task.	Task
		deleteAttachment(attachmentId:String):lc.foundation.util:Token Deletes the attachment from the task.	Task
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		forward(userOid:String):lc.foundation.util:Token Forwards the task to another user.	Task
		getAttachmentDocument(attachmentId:String):lc.foundation.util:ObjectToken Retrieves the attachment document from the task.	Task
		getCompletionComment():lc.foundation.util:Token Gets the completion comment(s) for the task.	Task
		getExtendedNote(id:String):lc.foundation.util:Token Retrieves an extended note.	Task
		getItemData(taskItemIndex:int):lc.foundation.util:ObjectToken Retrieves the data for a task item.	Task
		getTaskContainer():lc.foundation.util:ObjectToken Retrieves the container for the task, which is useful when you want to use operations to further manage the task.	Task
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		invokeStartpointFromStartTask():lc.foundation.util:ObjectToken Invokes the startpoint that created the Task object and uses the data from the current task as initial data for the task.	Task
		isLC8Task():Boolean Returns whether the task is an LiveCycle ES (version 8.x) task.	Task
		isMultiUser():Boolean Returns whether the task is a multi-user task on the Document Server.	Task
		isOwner():Boolean Indicates whether the current user is the owner of the task.	Task
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		isSingleUser():Boolean Returns whether the task is a single user task on the Document Server.	Task
		loadAssignments(forceLoad:Boolean = false):lc.foundation.util:Token Loads the assignments for the task.	Task
		loadAttachments(forceLoad:Boolean = false):lc.foundation.util:Token Loads the attachments for the task.	Task
		loadProcessInstance():lc.foundation.util:Token Loads the process instance for this task.	Task
		loadProcessVariables():lc.foundation.util:Token Loads the process variables for this task.	Task
		lock():lc.foundation.util:Token Locks the task, preventing other users from claiming the task.	Task
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		reject():lc.foundation.util:Token Rejects the task, which will return the task to the previous assigned user.	Task
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		renderItem(taskItemIndex:int, params:Object = null):lc.foundation.util:ObjectToken Retrieves a form for a task.	Task
		routeCommands():ArrayCollection Retrieves a collection of CompleteCommand objects, with one entry for each route.	Task
		saveItemData(taskItemIndex:int, data:Object):lc.foundation.util:Token Saves task item data to the server.	Task
		setCompletionComment(comment:String):lc.foundation.util:Token Adds a completion comment for the task.	Task
		setDescription(description:String):lc.foundation.util:Token Specifies a new description for the task.	Task
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setSession(session:SessionMap):void Sets the SessionMap object, which stores the information relating to the server session.	Task
		setVisible(visible:Boolean):lc.foundation.util:Token Specifies the visibility of a task.	Task
		share(userOid:String):lc.foundation.util:Token Shares the task with another user.	Task
		submitItemWithData(taskItemIndex:int, data:Object, params:Object = null):lc.foundation.util:ObjectToken Submits the current task item and associated data to the Document Server.	Task
		submitItemWithPriorData(taskItemIndex:int, dataKey:Object, params:Object = null):lc.foundation.util:ObjectToken Submits the previously saved task item data to the server.	Task
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		unlock():lc.foundation.util:Token Unlocks the task, which allows other users to claim the task if they have access to it.	Task
		updateAttachment(attachmentId:String, attachment:FileReference):lc.foundation.util:Token Updates the attachment document.	Task
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

assignments

property

assignments:ListCollectionView

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

The collection of Assignment objects for the task. The assignments property is not valid until the loadAssignments method has executed.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get assignments():ListCollectionView
public function set assignments(value:ListCollectionView):void

Related API Elements

lc.procmgmt.domain.Task.loadAssignments()
lc.procmgmt.domain.Assignment

attachments

property

attachments:ListCollectionView

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

A collection of Attachment objects for the task.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get attachments():ListCollectionView
public function set attachments(value:ListCollectionView):void

canInvokeFromStartTask

property

canInvokeFromStartTask:Boolean [read-only]

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

A flag that indicates whether the task can be used to re-initiate the same TaskManager startpoint that was used to create the task. A value of true indicates that the task can be used to re-initiate the same TaskManager startpoint.

Implementation
public function get canInvokeFromStartTask():Boolean

completeTime

property

completeTime:Date

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

The date and time that the task completed.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get completeTime():Date
public function set completeTime(value:Date):void

consultGroupId

property

consultGroupId: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

The group identifier that may be used when the consult operation is performed.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get consultGroupId():String
public function set consultGroupId(value:String):void

Related API Elements

lc.procmgmt.domain.Task.consult()

createTime

property

createTime:Date

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

The date and time that the task was created.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get createTime():Date
public function set createTime(value:Date):void

currentAssignment

property

currentAssignment:Assignment

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

The current assignment for the task.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get currentAssignment():Assignment
public function set currentAssignment(value:Assignment):void

Related API Elements

lc.procmgmt.domain.Assignment

deadline

property

deadline:Date

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

The date and time the task will be deadlined.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get deadline():Date
public function set deadline(value:Date):void

description

property

description: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

The task description.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get description():String
public function set description(value:String):void

forwardGroupId

property

forwardGroupId: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

The group identifier that may be used when the forward operation is performed.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get forwardGroupId():String
public function set forwardGroupId(value:String):void

Related API Elements

lc.procmgmt.domain.Task.forward()

instructions

property

instructions: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

The task instructions.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get instructions():String
public function set instructions(value:String):void

isActive

property

isActive:Boolean [read-only]

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 whether the task is active based on the task status. Any task that has been completed, deadlined or terminated is not an active task

Implementation
public function get isActive():Boolean

isDeadlined

property

isDeadlined:Boolean

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

A flag that indicates whether the task was deadlined. A deadlined task can no longer be completed and must be abandoned. The default value is false.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get isDeadlined():Boolean
public function set isDeadlined(value:Boolean):void

isDraft

property

isDraft:Boolean

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

A flag that indicates whether the task is saved as a draft. The default value is false.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get isDraft():Boolean
public function set isDraft(value:Boolean):void

isInitalTask

property

isInitalTask:Boolean

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 isInitialTask.

A flag that indicates whether the task has just been created from an startpoint. 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.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get isInitalTask():Boolean
public function set isInitalTask(value:Boolean):void

Related API Elements

isInitialTask

property

isInitialTask:Boolean

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

A flag that indicates whether the task was created from an startpoint. The process instance is not yet created for an initial task. An initial task can still be forwarded to another user. The default value is false.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get isInitialTask():Boolean
public function set isInitialTask(value:Boolean):void

isLocked

property

isLocked:Boolean

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

A flag that indicates whether the task is locked. A value of true indicates that the task is locked.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get isLocked():Boolean
public function set isLocked(value:Boolean):void

isRouteSelectionRequired

property

isRouteSelectionRequired:Boolean

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

A flag that indicates whether a route selection is required. A value of true indicates that a route selection is required.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get isRouteSelectionRequired():Boolean
public function set isRouteSelectionRequired(value:Boolean):void

isShowAttachments

property

isShowAttachments:Boolean

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

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.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get isShowAttachments():Boolean
public function set isShowAttachments(value:Boolean):void

isStartTask

property

isStartTask:Boolean

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

A flag that indicates whether this is a newly started task. A value of true indicates that this is a newly started task.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get isStartTask():Boolean
public function set isStartTask(value:Boolean):void

nextReminder

property

nextReminder:Date

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

The date and time the next reminder will trigger.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get nextReminder():Date
public function set nextReminder(value:Date):void

numForms

property

numForms:Number

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

The number of forms on the task.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get numForms():Number
public function set numForms(value:Number):void

numFormsToBeSaved

property

numFormsToBeSaved:Number

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

The number of forms to be saved on the task.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get numFormsToBeSaved():Number
public function set numFormsToBeSaved(value:Number):void

priority

property

priority:Number

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

The task's priority. A valid value for the priority is a value from the constants defined in the TaskConstants class.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get priority():Number
public function set priority(value:Number):void

Related API Elements

lc.procmgmt.TaskConstants

processInstance

property

processInstance:ProcessInstance

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

The process instance that owns this task. This property is not valid until the loadProcessInstance method is called.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get processInstance():ProcessInstance
public function set processInstance(value:ProcessInstance):void

Related API Elements

lc.procmgmt.domain.Task.loadProcessInstance()
lc.procmgmt.domain.ProcessInstance

processInstanceId

property

processInstanceId:Number

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

The identifier of the process instance object that owns this task. This is used to load the ProcessInstance object.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get processInstanceId():Number
public function set processInstanceId(value:Number):void

Related API Elements

lc.procmgmt.domain.Task.loadProcessInstance()

processInstanceStatus

property

processInstanceStatus:Number

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

The status of the process instance.

This value is a localized String value that is processed by looking up the numeric value in the resource bundle.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get processInstanceStatus():Number
public function set processInstanceStatus(value:Number):void

Related API Elements

lc.procmgmt.ProcessConstants

processVariables

property

processVariables:ListCollectionView

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

A collection of ProcessVariable objects that are related to this task.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get processVariables():ListCollectionView
public function set processVariables(value:ListCollectionView):void

Related API Elements

lc.procmgmt.domain.ProcessVariable

reminderCount

property

reminderCount:Number

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

The number of reminders that were issued for this task.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get reminderCount():Number
public function set reminderCount(value:Number):void

routeList

property

routeList:Array

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

An array of route names available for this task.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get routeList():Array
public function set routeList(value:Array):void

selectedRoute

property

selectedRoute: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

The selected route. This route is used when a form is completed.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get selectedRoute():String
public function set selectedRoute(value:String):void

Related API Elements

lc.procmgmt.domain.Task.complete()

serviceName

property

serviceName: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

The name of the service.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get serviceName():String
public function set serviceName(value:String):void

serviceTitle

property

serviceTitle: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

The title of the service.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get serviceTitle():String
public function set serviceTitle(value:String):void

session

property

session:SessionMap [read-only]

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

A SessionMap object that stores information relating to the server session.

Implementation
public function get session():SessionMap

status

property

status:Number

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

The task status. It may be one of the constants defined in the TaskConstants class.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get status():Number
public function set status(value:Number):void

Related API Elements

lc.procmgmt.TaskConstants

stepName

property

stepName: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

The name of the step.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get stepName():String
public function set stepName(value:String):void

taskACL

property

taskACL:lc.procmgmt.domain:TaskACL

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

The access control list for a task.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get taskACL():lc.procmgmt.domain:TaskACL
public function set taskACL(value:lc.procmgmt.domain:TaskACL):void

Related API Elements

lc.procmgmt.domain.TaskACL

taskId

property

taskId: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

The task identifier.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get taskId():String
public function set taskId(value:String):void

trcVariableName

property

trcVariableName:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9.0.0.1

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The task result collection variable name associated with the task.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get trcVariableName():String
public function set trcVariableName(value:String):void

updateTime

property

updateTime:Date

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

The date and time of the last update.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get updateTime():Date
public function set updateTime(value:Date):void

Method Detail

abandon

()

method

public function abandon():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.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

addAttachment

()

method

public function addAttachment(attachment:FileReference, permissions: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 the task.

Parameters

	`attachment:FileReference` — Specifies the `FileReference` object to be attached.

	`permissions:AttachmentPermissions` — Specifies the permissions to use for the attachment.

Returns

lc.foundation.util:Token — An object that represents the task to which the attachment was added.

addNote

()

method

public function addNote(title:String, note:String, permissions: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 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.

Returns

lc.foundation.util:ObjectToken — An object that represents the task to which the note was added.

availableCommands

()

method

public function availableCommands():ArrayCollection

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 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.

Returns

ArrayCollection — An object that represents commands available for each task.

claim

()

method

public function claim(lock: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

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.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

complete

()

method

public function complete():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

Completes the task. The selectedRoute property is used if it was supplied to the task.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

consult

()

method

public function consult(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 regarding assigned the task.

Parameters

userOid:String — Specifes the OID of the person to which to consult with regarding the task.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

deleteAttachment

()

method

public function deleteAttachment(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 the attachment from the task.

Parameters

attachmentId:String — Specifies the identifier of the attachment to delete.

Returns

lc.foundation.util:Token — An object that can be used to specify handlers for this asynchronous call.

forward

()

method

public function forward(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 to another user.

Parameters

userOid:String — Specifies the OID of the person to forward the task to.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

getAttachmentDocument

()

method

public function getAttachmentDocument(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 the attachment document from the task.

Parameters

attachmentId:String — Specifies the identifier of the attachment to be retrieved.

Returns

lc.foundation.util:ObjectToken — An object that contains a DocumentReference object. The returned object is used by the caller to specify handlers for this asynchronous call.

Related API Elements

lc.procmgmt.domain.DocumentReference

getCompletionComment

()

method

public function getCompletionComment():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

Gets the completion comment(s) for the task.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

getExtendedNote

()

method

public function getExtendedNote(id: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. Extended notes are files.

Parameters

id:String — Specifies the note identifier.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

getItemData

()

method

public function getItemData(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. Note that the item retrieved through renderItem may already contain merged data.

Parameters

taskItemIndex:int — Specifies the task item to be returned.

Returns

lc.foundation.util:ObjectToken — An object that contains 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 of type XML if the data is XML; otherwise, it is of type ByteArray.

getTaskContainer

()

method

public function getTaskContainer():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 container for the task, which is useful when you want to use operations to further manage the task.

Returns

lc.foundation.util:ObjectToken — An object that contains a DocumentReference object. The returned object is used by the caller to specify handlers for this asynchronous call.

invokeStartpointFromStartTask

()

method

public function invokeStartpointFromStartTask():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

Invokes the startpoint that created the Task object and uses the data from the current task as initial data for the task.

Returns

lc.foundation.util:ObjectToken — An object that contains the startpoint invocation result. A Task or a DocumentReference object is returned after successfully completing. You can set result and fault handlers on the token to be called when the invocation is complete and the result is returned. If the Task object does not support the ability to be invoked as a start task, an error is thrown.

isLC8Task

()

method

public function isLC8Task():Boolean

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 whether the task is an LiveCycle ES (version 8.x) task.

Returns

Boolean — Indicates whether the task is from a LiveCycle 8.x process.

isMultiUser

()

method

public function isMultiUser():Boolean

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 whether the task is a multi-user task on the Document Server.

Returns

Boolean — Whether the task is a multi-user or single user task. A Boolean value that specifies whether a task is a multiuser task. A value of true specifies that it is a multi-user task. A value of false indicates that it is a single user task.

isOwner

()

method

public function isOwner():Boolean

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

Indicates whether the current user is 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).

Returns

Boolean — Whether the current user is the owner of the the task. A value of True indicates that the user is hte owner of the task. A value of False indicates that the current users is not the owner of the task.

isSingleUser

()

method

public function isSingleUser():Boolean

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 whether the task is a single user task on the Document Server.

Returns

Boolean — Whether the task is a multi-user or single user task. A value of true specifies that it is a single user task. A value of false indicates that it is a multi-user task.

loadAssignments

()

method

public function loadAssignments(forceLoad:Boolean = false):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

Loads the assignments for the task. The assignments property is not valid until this method is executed.

Parameters

forceLoad:Boolean (default = false) — Specifies to force load the assignments when a value of true is provided.

Returns

lc.foundation.util:Token — An object that is used to specify handlers for this asynchronous call.

Related API Elements

lc.procmgmt.domain.Assignment

loadAttachments

()

method

public function loadAttachments(forceLoad:Boolean = false):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

Loads the attachments for the task.

Parameters

forceLoad:Boolean (default = false) — Specifies to force load the pending tasks when a value of true is provided.

Returns

lc.foundation.util:Token — An object that is used to specify handlers for this asynchronous call.

loadProcessInstance

()

method

public function loadProcessInstance():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

Loads the process instance for this task.

Returns

lc.foundation.util:Token — An object that is used the specify handlers for this asynchronous call.

loadProcessVariables

()

method

public function loadProcessVariables():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

Loads the process variables for this task.

Returns

lc.foundation.util:Token — A token that can be used by the caller to specify handlers for this asynchronous call.

lock

()

method

public function lock():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, preventing other users from claiming the task.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

reject

()

method

public function reject():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, which will return the task to the previous assigned user.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

renderItem

()

method

public function renderItem(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

	`taskItemIndex:int` — Reserved for future use.

	`params:Object` (default = `null`) — Specifies an optional map of parameters for the render service.

Returns

lc.foundation.util:ObjectToken — An object that is used to set result and fault handlers. The result and fault handlers are 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.

routeCommands

()

method

public function routeCommands():ArrayCollection

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 CompleteCommand objects, with one entry for each route.

Returns

ArrayCollection — An object representing a collection of CompleteCommand objects.

saveItemData

()

method

public function saveItemData(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 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`.

Returns

lc.foundation.util:Token — A token used to set result and fault handlers to be called when the operation is complete.

setCompletionComment

()

method

public function setCompletionComment(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

Adds a completion comment for the task.

Parameters

comment:String — Specifies the new comment.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

setDescription

()

method

public function setDescription(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

Specifies a new description for the task.

Parameters

description:String — Specifies the new description.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

setSession

()

method

public function setSession(session:SessionMap):void

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 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):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

Specifies the visibility of a task.

Parameters

visible:Boolean — Specifies whether to hide or display the task. A value of true displays the task.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

()

method

public function share(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 the task with another user.

Parameters

userOid:String — Specifies the object identifier of the person to share the task with.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

submitItemWithData

()

method

public function submitItemWithData(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 the current task item and associated data to the Document Server.

Parameters

	`taskItemIndex:int` — Specifies the data to be submitted.

	`data:Object` — Reserved for future use.

	`params:Object` (default = `null`) — Specifies an optional map of parameters for the render service.

Returns

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(taskItemIndex:int, dataKey: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 the previously saved task item data to the server.

Parameters

	`taskItemIndex:int` — Reserved for future use.

	`dataKey:Object` — Specifies the unique key to look up data in the current session.

	`params:Object` (default = `null`) — Specifies a map of parameters for the render service.

Returns

unlock

()

method

public function unlock():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, which allows other users to claim the task if they have access to it.

Returns

lc.foundation.util:Token — An object that is used to set result and fault handlers. The result and fault handlers are called when the operation is complete.

updateAttachment

()

method

public function updateAttachment(attachmentId:String, attachment: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 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.

Returns

lc.foundation.util:Token — An object that is used by the caller to specify handlers for this asynchronous call.

Legal Notices | Online Privacy Policy

Task - AS3 ADEP Workspace

Classes x

assignments

attachments

canInvokeFromStartTask

completeTime

consultGroupId

createTime

currentAssignment

deadline

description

forwardGroupId

instructions

isActive

isDeadlined

isDraft

isInitalTask

isInitialTask

isLocked

isRouteSelectionRequired

isShowAttachments

isStartTask

nextReminder

numForms

numFormsToBeSaved

priority

processInstance

processInstanceId

processInstanceStatus

processVariables

reminderCount

routeList

selectedRoute

serviceName

serviceTitle

session

status

stepName

taskACL

taskId

trcVariableName

updateTime

abandon

addAttachment

addNote

availableCommands

claim

complete

consult

deleteAttachment

forward

getAttachmentDocument

getCompletionComment

getExtendedNote

getItemData

getTaskContainer

invokeStartpointFromStartTask

isLC8Task

isMultiUser

isOwner

isSingleUser

loadAssignments

loadAttachments

loadProcessInstance

loadProcessVariables

lock

reject

renderItem

routeCommands

saveItemData

setCompletionComment

setDescription

setSession

setVisible

share

submitItemWithData

submitItemWithPriorData

unlock

updateAttachment