Packagelc.domain
Classpublic class TaskCommand
InheritanceTaskCommand Inheritance Object
Implements ICommand
Subclasses AbandonCommand, ClaimCommand, CompleteCommand, LockCommand, RejectCommand, SetVisibleCommand, TaskUserCommand, UnlockCommand

The TaskCommand class is a generic command that has direct association with a Task object. The TaskCommand class should not be used directly but extended by different types of commands for tasks.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  name : String
[read-only] The name of the command for the task.
TaskCommand
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  task : Task
The task that is associated with the command.
TaskCommand
Public Methods
 MethodDefined By
  
TaskCommand(task:Task, name:String)
Constructor.
TaskCommand
  
Retrieves a Token object to allow the caller to be notified when the execution is complete.
TaskCommand
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail
nameproperty
name:String  [read-only]

The name of the command for the task.


Implementation
    public function get name():String
taskproperty 
public var task:Task

The task that is associated with the command. When the command gets executed, the execution is against the current task.

The default value is null.

Constructor Detail
TaskCommand()Constructor
public function TaskCommand(task:Task, name:String)

Constructor.

Parameters
task:Task — Specifies the task to be associated with the command.
 
name:String — Specifies the name of the command.
Method Detail
execute()method
public function execute():Token

Retrieves a Token object to allow the caller to be notified when the execution is complete. The execute method must be overridden by the subclass.

Classes that extend the TaskCommand class should write their own execution code within the execute method.

Returns
Token — A token that allows the caller to be notified when the execution is complete. The default behavior of this method is to return a null Token object.




 

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/TaskCommand.html