ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
lc.procmgmt.commands 

EditDescriptionCommand  - AS3 ADEP Workspace

Packagelc.procmgmt.commands
Classpublic class EditDescriptionCommand
InheritanceEditDescriptionCommand Inheritance TaskCommand Inheritance Object

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 EditDescriptionCommand class sets a new description for a task.

Related API Elements



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  description : String
The new description for the task.
EditDescriptionCommand
 Inheritedname : String
[read-only] The name of the command for the task.
TaskCommand
 Inheritedtask : lc.procmgmt.domain:Task
The task that is associated with the command.
TaskCommand
Public Methods
 MethodDefined By
  
Constructor.
EditDescriptionCommand
  
[override] Changes the description of the task by executing the setDescription method from the Task object.
EditDescriptionCommand
 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 this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  NAME : String = "EditDescription"
[static] The name of the EditDescriptionCommand command.
EditDescriptionCommand
Property Detail

description

property
public var 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 new description for the task.

Constructor Detail

EditDescriptionCommand

()Constructor
public function EditDescriptionCommand(task:lc.procmgmt.domain:Task, description:String = null)

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

Constructor.

Parameters
task:lc.procmgmt.domain:Task — Specifies the task to be associated with the command.
 
description:String (default = null) — Specifies the string value the new description.
Method Detail

execute

()method
override public function execute():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

Changes the description of the task by executing the setDescription method from the Task object.

Returns
lc.foundation.util:Token — A token that notifies the caller when execution is complete.

Related API Elements

Constant Detail

NAME

Constant
public static const NAME:String = "EditDescription"

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