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 

ProjectVO  - AS3 Project Management
Packagecom.adobe.solutions.prm.vo
Classpublic class ProjectVO
InheritanceProjectVO 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)

Defines a project entity. Project can have sub-projects or work items

Related API Elements

Since projects support nested sub-projects, this can be used to model a different hierarchy. A project entity has a type attribute, which can be used to classify a project entity. This can allow different projects to have different semantics, if desired. For example, the current implementation use two types Campaign and Project, where Campaign is a root project and Project is associated with its children. Top project in a hierarchy is called root project and an immediate parent is referred to as a parent project.

Public Properties
 PropertyDefined By
 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
  defaultWorkItemTemplateName : String
Defines the default workItem template name.
ProjectVO
 Inheriteddescription : String
Description.
BaseEntityVO
  editedTemplate : Boolean
Defines a Boolean flag that indicates if workItems use a template identified by a name specified in defaultWorkItemTemplate, or use a template definition stored along with the project as reviewTemplate.
ProjectVO
  endDate : Date
Defines the end date of a project.
ProjectVO
  expectedEndDate : Date
Defines the expected end date of a project.
ProjectVO
  icon : File
Defines the icon used in a project.
ProjectVO
 Inheritedid : String
Unique identifier.
BaseEntityVO
  inheritDocsFromParent : Boolean
Defines the current value of inheritDocsFromParent flag.
ProjectVO
 InheritedlastUpdatedBy : String
Principal name for a user who last updated an entity.
BaseEntityVO
 InheritedlastUpdatedDate : Date
Date when an entity was last updated.
BaseEntityVO
  localUsers : IList
Defines a list of local users of the project.
ProjectVO
  members : ArrayCollection
Defines list of members of a project, replacing an existing list of members, if present.
ProjectVO
  messages : IList
Defines the messages to a project.
ProjectVO
  milestones : IList
Defines the list of milestones associated with a project.
ProjectVO
  name : String
Defines the name of a project.
ProjectVO
  owner : String
Defines the owner of a project.
ProjectVO
  parentProject : ProjectVO
Defines the parent project for a project.
ProjectVO
  projects : IList
Defines the list of child projects.
ProjectVO
  referenceDocuments : IList
Defines the reference documents associated with a project.
ProjectVO
  reviewTemplate : com.adobe.solutions.rca.vo:ReviewTemplateVO
Defines the review template to be inherited by children.
ProjectVO
  rootProject : ProjectVO
Defines the root project.
ProjectVO
  startDate : Date
Defines the start date of a project.
ProjectVO
  state : String
Defines the state of a project.
ProjectVO
  status : String
Defines the status of a project.
ProjectVO
  statusReasonCode : String
Defines the status reason code.
ProjectVO
 Inheritedtags : IList
Defines the list of tags that can be associated with an entity.
ExtendableTaggedEntityVO
  type : String
Defines the type of a project.
ProjectVO
  workItems : IList
Defines the list of workItems.
ProjectVO
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
  
ProjectVO()
The constructor for ProjectVO class.
ProjectVO
 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
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
BaseEntityVO
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
BaseEntityVO
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
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
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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.
BaseEntityVO
Property Detail

defaultWorkItemTemplateName

property
defaultWorkItemTemplateName:String

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

Defines the default workItem template name. Every workItem is associated with a RCA template. If a template is not directly associated with a workItem then a template is inherited from a parent project in the hierarchy, going from bottom to top. The default workItem template specifies the template name to be used at project. This can eventually be inherited by children workItems. Template name being unique, you need to specify only the name. Ensure that a 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 defaultWorkItemTemplateName():String
    public function set defaultWorkItemTemplateName(value:String):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 a Boolean flag that indicates if workItems use a template identified by a name specified in defaultWorkItemTemplate, or use a template definition stored along with the project as reviewTemplate. If it is True then reviewTemplate is used, else defaultWorkItemTemplate is used. There are two ways to associated a template with a project. You can either use setReviewTemplate or use setDefaultWorkItemTemplateName. While creating a project, you must set the editedTemplate flag appropriately.

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 project. Since the end date is a calculated field, client should not 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 of a project. If expectedEndDate is null, then it is inherited from the parent project. For this reason, a root project can not have a null 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

icon

property 
icon:File

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

Defines the icon used in a project. Icon is an image, that is associate with a project, for easy reference as a visual indicator.

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 icon():File
    public function set icon(value:File):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 project inherits reference documents from the parent project. If it 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

localUsers

property 
localUsers:IList

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 local users of the project. Local users can be used to keep a list of users associated with a project, who have been assigned an organization title. This list of local user has no runtime significance. It is provided just as a convenient data structure to keep a local cache of users associated with a 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 localUsers():IList
    public function set localUsers(value:IList):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 list of members of a project, replacing an existing list of members, if present. Team members get notifications of various events during the life cycle of a 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 members():ArrayCollection
    public function set members(value:ArrayCollection):void

messages

property 
messages:IList

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

Defines the messages to a 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 messages():IList
    public function set messages(value:IList):void

milestones

property 
milestones: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 milestones associated with a 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 milestones():IList
    public function set milestones(value:IList):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 a project. Project name is a mandatory attribute and should not be null. [ ] / | * . .. : and trailing spaces are not allowed in the project 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 project. Owner information is stored as Principal Name of a 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 parent project for a project. This method is used internally and should not be used by a 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 parentProject():ProjectVO
    public function set parentProject(value:ProjectVO):void

projects

property 
projects: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 child projects.

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

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 review template to be inherited by children. If a template is edited in context of a project, the reviewTemplate instance is stored locally, along with the project definition.

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

com.adobe.solutions.rca.vo.ReviewTemplateVO

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 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 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 the start date of a project. If a start date is set in future, then project is scheduled to start on that date. If the start date is in the past or is a current date, then the project starts immediately, upon project activation. If the start date of a project is null, then the start date is inherited from a parent project. For this reason, a root project can not have a null start 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 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 project. Since the state is a calculated attribute, clients should not call this setter. For possible values in the default implementation, please refer to com.adobe.solutions.prm.constant.ProjectState.

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

Related API Elements

com.adobe.solutions.prm.constant.ProjectState

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

Related API Elements

com.adobe.solutions.prm.constant.ProjectStatus

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 information about the status, provide reason for specific status being set. The default implementation has two status, reed and green. Red status indicates that an action is required or an error has occurred. Green status indicates desired progress.

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

com.adobe.solutions.prm.constants.ProjectStatus
com.adobe.solutions.prm.constant.StatusReasonCode

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

Related API Elements

com.adobe.solutions.prm.constant.ProjectType

workItems

property 
workItems: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 workItems.

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

ProjectVO

()Constructor
public function ProjectVO()

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

The constructor for ProjectVO class.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy