ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.solutions.prm.vo 

WorkItemVO  - AS3 Project Management

Packagecom.adobe.solutions.prm.vo
Classpublic class WorkItemVO
InheritanceWorkItemVO Inheritance ExtendableTaggedEntityVO Inheritance BaseEntityVO Inheritance Object
Implements IManaged

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

A workItem describes a unit of work within a project. Work items can have a work flow associated with it. A template can be any document or a XML file, that describes this associated work flow. The two ways to pass a template are, either by name using templateName, or using a template instance. Use an instance, if a template definition has modifications to it. Use the templateName, if there is no change in the template definition. If a template has modifications to it, then it is first stored and then used. Template is stored using a uniquely generated template ID, referred to as templateGeneratedName.



Public Properties
 PropertyDefined By
  asset : AssetVO
Defines the asset of WorkItem.
WorkItemVO
 Inheritedattributes : Object
Defines the map of key value pair attributes.
ExtendableTaggedEntityVO
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcreatedBy : String
Principal name for a user who created an entity.
BaseEntityVO
 InheritedcreationDate : Date
Date of creation of an entity.
BaseEntityVO
 Inheriteddescription : String
Description.
BaseEntityVO
  editedTemplate : Boolean
Defines the current value of editedTemplate flag.
WorkItemVO
  endDate : Date
Defines the end date of a workItem.
WorkItemVO
  expectedEndDate : Date
Defines the expected end date for a workItem.
WorkItemVO
 Inheritedid : String
Unique identifier.
BaseEntityVO
  inheritDocsFromParent : Boolean
Defines the current value of inheritDocsFromParent flag.
WorkItemVO
  instanceId : String
Defines the instance ID of the workflow associated with a workItem.
WorkItemVO
 InheritedlastUpdatedBy : String
Principal name for a user who last updated an entity.
BaseEntityVO
 InheritedlastUpdatedDate : Date
Date when an entity was last updated.
BaseEntityVO
  members : ArrayCollection
Defines a list of members of the project.
WorkItemVO
  name : String
Defines the name of the workItem, workItem name is a mandatory attribute should not be null.
WorkItemVO
  owner : String
Defines the owner of a workItem.
WorkItemVO
  parentProject : ProjectVO
Defines the immediate parent of a workItem in the project hierarchy.
WorkItemVO
  referenceDocuments : IList
Defines the reference documents associated with a workItem.
WorkItemVO
  reviewContextList : IList
Defines the list of reviewContext List, If the workitem is has a running instance of review associated with it, then it gives list of review context each corresponding to a different revision of review.
WorkItemVO
  reviewTemplate : com.adobe.solutions.rca.vo:ReviewTemplateVO
Defines the reivewTemplate.
WorkItemVO
  rootProject : ProjectVO
Defines the root project.
WorkItemVO
  startDate : Date
Defines start date of a workItem.
WorkItemVO
  state : String
Defines the state of a WorkItem.
WorkItemVO
  status : String
Defines the status of a WorkItem.
WorkItemVO
  statusReasonCode : String
Defines the status reason code.
WorkItemVO
 Inheritedtags : IList
Defines the list of tags that can be associated with an entity.
ExtendableTaggedEntityVO
  templateName : String
Defines the workItem template name.
WorkItemVO
  type : String
Defines the type of workItem.
WorkItemVO
  workflowDisposition : String
Stores additional status information about the status of workflow associated with a workItem.
WorkItemVO
Protected Properties
 PropertyDefined By
 Inherited_attributes : Object
Map of key value pair attributes.
ExtendableTaggedEntityVO
 Inherited_createdBy : String
Principal name for a user who created an entity.
BaseEntityVO
 Inherited_creationDate : Date
Creation date for an entity.
BaseEntityVO
 Inherited_description : String
Description of an entity.
BaseEntityVO
 Inherited_id : String
Unique identifier.
BaseEntityVO
 Inherited_lastUpdatedBy : String
Principal name for a user who last updated an entity.
BaseEntityVO
 Inherited_lastUpdatedDate : Date
Date when an entity was last updated.
BaseEntityVO
 Inherited_tags : ArrayCollection
List of tags that can be associated with an entity.
ExtendableTaggedEntityVO
Public Methods
 MethodDefined By
  
The constructor for WorkItemVO class.
WorkItemVO
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
BaseEntityVO
 Inherited
Dispatches an event into the event flow.
BaseEntityVO
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
BaseEntityVO
 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
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
BaseEntityVO
 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
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
BaseEntityVO
Property Detail

asset

property
asset:AssetVO

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the asset of WorkItem.

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 asset():AssetVO
    public function set asset(value:AssetVO):void

editedTemplate

property 
editedTemplate:Boolean

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the current value of editedTemplate flag. If this Boolean flag is set to True, a template has been locally modified for this work item.

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 editedTemplate():Boolean
    public function set editedTemplate(value:Boolean):void

endDate

property 
endDate:Date

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the end date of a workItem. As the end date is a calculated field, client should never call the setter.

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 endDate():Date
    public function set endDate(value:Date):void

expectedEndDate

property 
expectedEndDate:Date

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the expected end date for a workItem. If expectedEndDate is null, then it is inherited from the parent project. For this reason, a root project can not have a null value for the expected end date.

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 expectedEndDate():Date
    public function set expectedEndDate(value:Date):void

inheritDocsFromParent

property 
inheritDocsFromParent:Boolean

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the current value of inheritDocsFromParent flag. If this Boolean flag is set to True, the workItem inherits the reference documents from parent project and so on. If the flag is set to False, then it does not inherit reference documents.

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 inheritDocsFromParent():Boolean
    public function set inheritDocsFromParent(value:Boolean):void

instanceId

property 
instanceId:String

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the instance ID of the workflow associated with a workItem. Instance ID uniquely identifies an ongoing workflow instance.

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 instanceId():String
    public function set instanceId(value:String):void

members

property 
members:ArrayCollection

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines a list of members of the project. Replaces any existing list of members. Team members get a notification of various events during a workItem life cycle.

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 members():ArrayCollection
    public function set members(value:ArrayCollection):void

name

property 
name:String

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the name of the workItem, workItem name is a mandatory attribute should not be null. [ ] / | * . .. : and trailing spaces are not allowed in the name.

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 name():String
    public function set name(value:String):void

owner

property 
owner:String

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the owner of a workItem. Owner information is stored as Principal Name of 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 owner():String
    public function set owner(value:String):void

parentProject

property 
parentProject:ProjectVO

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the immediate parent of a workItem in the project hierarchy. Since a project can have only one immediate parent, only a single instance of project is returned. Please note that for the first level children in a project hierarchy, parent project or root project have the same value. Parent project value is null for a root project itself.

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 parentProject():ProjectVO
    public function set parentProject(value:ProjectVO):void

referenceDocuments

property 
referenceDocuments:IList

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the reference documents associated with a workItem.

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 referenceDocuments():IList
    public function set referenceDocuments(value:IList):void

reviewContextList

property 
reviewContextList:IList

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the list of reviewContext List, If the workitem is has a running instance of review associated with it, then it gives list of review context each corresponding to a different revision of review.

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 reviewContextList():IList
    public function set reviewContextList(value:IList):void

Related API Elements

reviewTemplate

property 
reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the reivewTemplate. It keeps the edited value or the populated value of a review template, based on templateName.

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 reviewTemplate():com.adobe.solutions.rca.vo:ReviewTemplateVO
    public function set reviewTemplate(value:com.adobe.solutions.rca.vo:ReviewTemplateVO):void

Related API Elements

rootProject

property 
rootProject:ProjectVO

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the root project. This method is used internally and should not be used by a client.

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 rootProject():ProjectVO
    public function set rootProject(value:ProjectVO):void

startDate

property 
startDate:Date

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines start date of a workItem. If start date is set in future, then workItem is scheduled to start on the future date. If start date is in past or current date, then such a workItem starts, as soon as the workItem is activated. If the start date of a workItem is null, then the start date is inherited from the parent project.

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 startDate():Date
    public function set startDate(value:Date):void

state

property 
state:String

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the state of a WorkItem.

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 state():String
    public function set state(value:String):void

status

property 
status:String

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the status of a WorkItem.

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():String
    public function set status(value:String):void

statusReasonCode

property 
statusReasonCode:String

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the status reason code. Reason codes provide more information about the status and provide reason for specific status being set. In the default implementation, it has only two status, red and green

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 statusReasonCode():String
    public function set statusReasonCode(value:String):void

Related API Elements

Red status indicates that an action is required or an error has occured. Green indicates desirable progress.
com.adobe.solutions.prm.constant.StatusReasonCode

templateName

property 
templateName:String

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the workItem template name. Every workItem is associated with a RCA template. If a template is not directly assigned to a workItem, then a template is inherited from a parent project in the hierarchy, going from bottom to top. You need to specify only the template name, since it is unique. Ensure that the template exists before it is used.

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 templateName():String
    public function set templateName(value:String):void

type

property 
type:String

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Defines the type of workItem. This attribute is not used in the current implementation, but the provided value is stored and associated with the workItem. A custom implementation can use the type, if 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 type():String
    public function set type(value:String):void

workflowDisposition

property 
workflowDisposition:String

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Stores additional status information about the status of workflow associated with a workItem. It is not used in the current implementation. It is reserved for future use.

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 workflowDisposition():String
    public function set workflowDisposition(value:String):void
Constructor Detail

WorkItemVO

()Constructor
public function WorkItemVO()

Language Version: ActionScript 3.0
Product Version: Project Management Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The constructor for WorkItemVO class.