| Package | com.adobe.solutions.prm.domain.impl |
| Class | public class Project |
| Inheritance | Project  EventDispatcher Object |
| Implements | IProject |
| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| allMemberList : IList [read-only]
The property returns a collection of all members. | Project | ||
| attributes : Object
Defines the map of key value pair attributes. | Project | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| createdBy : String
Principal name for a user who created an entity. | Project | ||
| creationDate : Date
Date of creation of an entity. | Project | ||
| defaultWorkItemTemplateName : String
Defines the default workItem template name. | Project | ||
| description : String
Description. | Project | ||
| documents : ArrayCollection [read-only]
The property returns a collection of associated documents. | Project | ||
| 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. | Project | ||
| endDate : Date
Defines the end date of a project. | Project | ||
| expectedEndDate : Date
Defines the expected end date of a project. | Project | ||
| ganttItems : ArrayCollection [read-only]
A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True. | Project | ||
| icon : File
Defines the icon used in a project. | Project | ||
| id : String
Unique identifier. | Project | ||
| inheritDocsFromParent : Boolean
Defines the current value of inheritDocsFromParent flag. | Project | ||
| itemEndDate : Date [read-only]
End date of the item. | Project | ||
| itemName : String [read-only]
Name of the item. | Project | ||
| itemStartDate : Date [read-only]
Start date of the item. | Project | ||
| itemState : String [read-only]
State of the item. | Project | ||
| itemStatus : String [read-only]
Status of the item. | Project | ||
| itemType : String [read-only]
Type of item. | Project | ||
| lastUpdatedBy : String
Principal name for a user who last updated an entity. | Project | ||
| lastUpdatedDate : Date
Date when an entity was last updated. | Project | ||
| memberList : IList [read-only]
The property returns a collection of directly associated members. | Project | ||
| members : IList
Defines list of members of a project, replacing an existing list of members, if present. | Project | ||
| messages : IList
Defines the messages to the project. | Project | ||
| milestones : IList | Project | ||
| name : String
Defines the name of a project. | Project | ||
| operationList : ArrayCollection [read-only]
A collection of operations that are available to a user through the context menu in the Gantt chart. | Project | ||
| owner : IUser
Defines the owner of a project. | Project | ||
| parentProject : IProject
Defines the parent project for a project. | Project | ||
| projects : IList
Defines the list of child projects. | Project | ||
| referenceDocuments : IList
Defines the reference documents associated with a project. | Project | ||
| reviewTemplate : com.adobe.solutions.rca.domain:IReviewTemplate
Defines the review template that is to be inherited by children. | Project | ||
| rootProject : IProject
Defines the root project. | Project | ||
| showChildren : Boolean
A Boolean flag to determine if the children need to be displayed. | Project | ||
| showParent : Boolean
A Boolean flag to determine if the parent needs to be displayed. | Project | ||
| startDate : Date
Defines the start date of a project. | Project | ||
| state : String
Defines the state of a project. | Project | ||
| status : String
Defines the status of a project. | Project | ||
| statusReasonCode : String
Defines the status reason code. | Project | ||
| tags : IList
Defines the list of tags that can be associated with an entity. | Project | ||
| type : String
Defines the type of a project. | Project | ||
| uniqueMemberList : IList [read-only]
The property returns a collection of unique members. | Project | ||
| users : IList
Defines a list of local users of the project. | Project | ||
| vo : ProjectVO
This property refers to an instance of the project value object. | Project | ||
| workItems : IList
Defines the list of workItems. | Project | ||
| Method | Defined By | ||
|---|---|---|---|
The constructor of Project class. | Project | ||
This remote operation activates a current project and its child projects or workItems. | Project | ||
This remote operation adds a document from the collection and submits the change on the server. | Project | ||
| 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 | |
This remote operation adds a member to the collection and submits the change to the server. | Project | ||
This method adds a project to a collection of projects. | Project | ||
This remote operation adds a sub-project to the current project and updates it on the server. | Project | ||
This method adds a reference document to a collection of referenceDocuments. | Project | ||
This method adds a team member to a collection of members. | Project | ||
This method adds a workitem to a collection of workitems. | Project | ||
This remote operation adds a workitem to the current project and updates the changes on the server. | Project | ||
|
Dispatches an event into the event flow. | EventDispatcher | |
This remote operation fetches a complete project from a server. | Project | ||
This method gets the title of a member, if any title is assigned to a user. | Project | ||
A Boolean function to determine if the item has displayable children. | Project | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
This remote operation removes itself from its parent project and updates the change on the server. | Project | ||
This remote operation removes a document from the collection and submits the change on the server. | Project | ||
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
This remote operation removes a member from the collection and submits the change to the server. | Project | ||
This method removes a team member, at the specified index, from a collection of members. | Project | ||
This remote operation removes a sub-project from the current project and updates the change on the server. | Project | ||
This method removes a project at the specified index from a collection of projects. | Project | ||
This method removes a reference document, at the specified index, from a collection of referenceDocuments. | Project | ||
This remote operation removes a workitem from the current project and updates the changes on the server. | Project | ||
This method removes a workitem at a specified index from a collection of workitems. | Project | ||
This remote operation saves the current state of a project on a server. | Project | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
This remote operation terminates the current project. | Project | ||
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
This remote operation updates the tile of a member present in collection and submits the change to the server. | Project | ||
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
allMemberList | property |
allMemberList:IList [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
The property returns a collection of all members. It takes into consideration any child objects that may be of type IMemberCollection.
This property can be used as the source for data binding. When this property is modified, it dispatches the memberListChanged event.
Implementation
public function get allMemberList():IListattributes | property |
attributes:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Defines the map of key value pair attributes.
Implementation
public function get attributes():Object public function set attributes(value:Object):voidcreatedBy | property |
createdBy:String| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Principal name for a user who created an entity.
Implementation
public function get createdBy():String public function set createdBy(value:String):voidcreationDate | property |
defaultWorkItemTemplateName | property |
defaultWorkItemTemplateName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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.
Implementation
public function get defaultWorkItemTemplateName():String public function set defaultWorkItemTemplateName(value:String):voiddescription | property |
documents | property |
documents:ArrayCollection [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
The property returns a collection of associated 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 documents():ArrayCollectioneditedTemplate | property |
editedTemplate:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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.
Implementation
public function get editedTemplate():Boolean public function set editedTemplate(value:Boolean):voidendDate | property |
endDate:Date| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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.
Implementation
public function get endDate():Date public function set endDate(value:Date):voidexpectedEndDate | property |
expectedEndDate:Date| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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.
Implementation
public function get expectedEndDate():Date public function set expectedEndDate(value:Date):voidganttItems | property |
ganttItems:ArrayCollection [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True.
This property can be used as the source for data binding. When this property is modified, it dispatches the ganttItemsChanged event.
Implementation
public function get ganttItems():ArrayCollectionicon | property |
icon:File| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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.
Implementation
public function get icon():File public function set icon(value:File):voidid | property |
inheritDocsFromParent | property |
inheritDocsFromParent:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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.
Implementation
public function get inheritDocsFromParent():Boolean public function set inheritDocsFromParent(value:Boolean):voiditemEndDate | property |
itemEndDate:Date [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
End date of the item.
This property can be used as the source for data binding. When this property is modified, it dispatches the ganttDataItemDurationChanged event.
Implementation
public function get itemEndDate():DateitemName | property |
itemName:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Name of the item.
This property can be used as the source for data binding. When this property is modified, it dispatches the ganttDataItemNameChanged event.
Implementation
public function get itemName():StringitemStartDate | property |
itemStartDate:Date [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Start date of the item.
This property can be used as the source for data binding. When this property is modified, it dispatches the ganttDataItemDurationChanged event.
Implementation
public function get itemStartDate():DateitemState | property |
itemState:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
State of the item.
This property can be used as the source for data binding. When this property is modified, it dispatches the ganttDataItemStateChanged event.
Implementation
public function get itemState():StringitemStatus | property |
itemStatus:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Status of the item.
This property can be used as the source for data binding. When this property is modified, it dispatches the ganttDataItemStatusChanged event.
Implementation
public function get itemStatus():StringitemType | property |
lastUpdatedBy | property |
lastUpdatedBy:String| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Principal name for a user who last updated an entity.
Implementation
public function get lastUpdatedBy():String public function set lastUpdatedBy(value:String):voidlastUpdatedDate | property |
lastUpdatedDate:Date| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Date when an entity was last updated.
Implementation
public function get lastUpdatedDate():Date public function set lastUpdatedDate(value:Date):voidmemberList | property |
memberList:IList [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
The property returns a collection of directly associated members.
This property can be used as the source for data binding. When this property is modified, it dispatches the memberListChanged event.
Implementation
public function get memberList():IListmembers | property |
members:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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.
Implementation
public function get members():IList public function set members(value:IList):voidRelated API Elements
messages | property |
messages:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Defines the messages to the project. It is a collection of type MessageVO.
Implementation
public function get messages():IList public function set messages(value:IList):voidRelated API Elements
milestones | property |
name | property |
name:String| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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.
Implementation
public function get name():String public function set name(value:String):voidoperationList | property |
operationList:ArrayCollection [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
A collection of operations that are available to a user through the context menu in the Gantt chart.
Implementation
public function get operationList():ArrayCollectionowner | property |
owner:IUser| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Defines the owner of a project. Owner information is fetched based on Principal Name of the user present in ProjectVO.
This property can be used as the source for data binding. When this property is modified, it dispatches the ownerUpdated event.
Implementation
public function get owner():IUser public function set owner(value:IUser):voidparentProject | property |
parentProject:IProject| 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.
Implementation
public function get parentProject():IProject public function set parentProject(value:IProject):voidprojects | property |
projects:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Defines the list of child projects. It is the collection of IProject.
Implementation
public function get projects():IList public function set projects(value:IList):voidreferenceDocuments | property |
referenceDocuments:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Defines the reference documents associated with a project.
Implementation
public function get referenceDocuments():IList public function set referenceDocuments(value:IList):voidRelated API Elements
reviewTemplate | property |
reviewTemplate:com.adobe.solutions.rca.domain:IReviewTemplate| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Defines the review template that is to be inherited by children. If the template is locally edited in context of a project, an instance of the review templateis is stored with the project definition.
Implementation
public function get reviewTemplate():com.adobe.solutions.rca.domain:IReviewTemplate public function set reviewTemplate(value:com.adobe.solutions.rca.domain:IReviewTemplate):voidRelated API Elements
rootProject | property |
rootProject:IProject| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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.
Implementation
public function get rootProject():IProject public function set rootProject(value:IProject):voidshowChildren | property |
showChildren:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
A Boolean flag to determine if the children need to be displayed.
Implementation
public function get showChildren():Boolean public function set showChildren(value:Boolean):voidshowParent | property |
showParent:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
A Boolean flag to determine if the parent needs to be displayed.
Implementation
public function get showParent():Boolean public function set showParent(value:Boolean):voidstartDate | property |
startDate:Date| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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.
Implementation
public function get startDate():Date public function set startDate(value:Date):voidstate | property |
state:String| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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.
Implementation
public function get state():String public function set state(value:String):voidRelated API Elements
status | property |
status:String| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Defines the status of a project.
Implementation
public function get status():String public function set status(value:String):voidRelated API Elements
statusReasonCode | property |
statusReasonCode:String| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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.
Implementation
public function get statusReasonCode():String public function set statusReasonCode(value:String):voidRelated API Elements
tags | property |
tags:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Defines the list of tags that can be associated with an entity.
Implementation
public function get tags():IList public function set tags(value:IList):voidtype | property |
uniqueMemberList | property |
uniqueMemberList:IList [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
The property returns a collection of unique members.
This property can be used as the source for data binding. When this property is modified, it dispatches the memberListChanged event.
Implementation
public function get uniqueMemberList():IListusers | property |
users:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| 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.
Implementation
public function get users():IList public function set users(value:IList):voidvo | property |
vo:ProjectVO| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This property refers to an instance of the project value object.
Implementation
public function get vo():ProjectVO public function set vo(value:ProjectVO):voidworkItems | property |
workItems:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Defines the list of workItems.
Implementation
public function get workItems():IList public function set workItems(value:IList):voidRelated API Elements
Project | () | Constructor |
public function Project(value:ProjectVO, parent:IProject, root:IProject)| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10.0 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
The constructor of Project class. It creates a project using project value object and reference to the parent project and root project.
value:ProjectVO — Project value object.
| |
parent:IProject — Reference of parent project to which this project is assigned.
| |
root:IProject — Reference of top level project, that is, the root node of the tree in which this project is assigned.
|
activate | () | method |
public function activate():mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation activates a current project and its child projects or workItems.
Returnsmx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains the value object of the activated project.
|
addDocumentAndSave | () | method |
public function addDocumentAndSave(doc:ISupportingDocument):mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation adds a document from the collection and submits the change on the server.
Parameters
doc:ISupportingDocument — The document to be added to document collection.
|
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.
|
addMemberAndSave | () | method |
public function addMemberAndSave(member:IMember):mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation adds a member to the collection and submits the change to the server.
Parameters
member:IMember — The member to be added to member collection.
|
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.
|
addProject | () | method |
public function addProject(project:IProject):void| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method adds a project to a collection of projects. It adds the project locally and not on a server.
Parameters
project:IProject — The project to be added.
|
addProjectAndSave | () | method |
public function addProjectAndSave(project:IProject):mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation adds a sub-project to the current project and updates it on the server. If the operation is successful, it refreshes the current object with a new value object returned from the server.
Parameters
project:IProject — A project to be added.
|
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains the value object of the project.
|
addReferenceDocument | () | method |
public function addReferenceDocument(doc:ISupportingDocument):void| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method adds a reference document to a collection of referenceDocuments.
It adds the document locally and not on a server.
Parameters
doc:ISupportingDocument — Reference document to be added.
|
addTeamMember | () | method |
public function addTeamMember(teamMember:com.adobe.solutions.prm.domain:ITeamMember):void| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method adds a team member to a collection of members. It adds a team member locally and not on a server.
Parameters
teamMember:com.adobe.solutions.prm.domain:ITeamMember — Team Member to be added.
|
addWorkItem | () | method |
public function addWorkItem(item:IWorkItem):void| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method adds a workitem to a collection of workitems. It adds the workitem locally and not on a server.
Parameters
item:IWorkItem — The WorkItem to be added.
|
addWorkItemAndSave | () | method |
public function addWorkItemAndSave(workItem:IWorkItem):mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation adds a workitem to the current project and updates the changes on the server. If operation is successful, it refreshes the current object with a new value object returned from the server.
Parameters
workItem:IWorkItem — A WorkItem to be added.
|
mx.rpc:AsyncToken — It returns a token on which success fault handlers can be attached. The resulting event contains the value object of the added workitem.
|
fetchCompleteProject | () | method |
public function fetchCompleteProject():mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation fetches a complete project from a server. Value object property of the current project is updated with that of the fetched project. This operation can be used to synchronise data on a client from a server.
Returnsmx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains the value object of the project, including the child projects.
|
getMemberTitle | () | method |
public function getMemberTitle(member:IMember):String| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method gets the title of a member, if any title is assigned to a user.
Parameters
member:IMember — An instance of the member whose title is required.
|
String — The title of the member.
|
hasChildren | () | method |
public function hasChildren():Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
A Boolean function to determine if the item has displayable children.
ReturnsBoolean — It returns a True value if there are displayable children.
|
remove | () | method |
public function remove():mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation removes itself from its parent project and updates the change on the server.
Returnsmx.rpc:AsyncToken — It returns a token on which success fault handlers can be attached. The resulting event contains the value object of the removed project.
|
removeDocumentAndSave | () | method |
public function removeDocumentAndSave(doc:ISupportingDocument):mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation removes a document from the collection and submits the change on the server.
Parameters
doc:ISupportingDocument — The document to be removed from document collection.
|
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.
|
removeMemberAndSave | () | method |
public function removeMemberAndSave(member:IMember):mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation removes a member from the collection and submits the change to the server.
Parameters
member:IMember — The member to be removed from member collection.
|
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.
|
removeMemberAt | () | method |
public function removeMemberAt(index:int):com.adobe.solutions.prm.domain:ITeamMember| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method removes a team member, at the specified index, from a collection of members. It removes a team member locally and not from a server.
Parameters
index:int — Index of the member to be removed.
|
com.adobe.solutions.prm.domain:ITeamMember — It returns a reference to the removed member.
|
removeProjectAndSave | () | method |
public function removeProjectAndSave(project:IProject):mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation removes a sub-project from the current project and updates the change on the server.
Parameters
project:IProject — A sub-project to be removed.
|
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains the value object of the removed project.
|
removeProjectAt | () | method |
public function removeProjectAt(index:int):IProject| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method removes a project at the specified index from a collection of projects. It removes the project locally and not from a server.
Parameters
index:int — Index of the project to be removed.
|
IProject — It returns a reference to the removed project.
|
removeReferenceDocumentAt | () | method |
public function removeReferenceDocumentAt(index:int):ISupportingDocument| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method removes a reference document, at the specified index, from a collection of referenceDocuments.
It removes the reference document locally and not on a server.
Parameters
index:int — Index of the reference document to be removed.
|
ISupportingDocument — It returns a reference to the removed document.
|
removeWorkItemAndSave | () | method |
public function removeWorkItemAndSave(workItem:IWorkItem):mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation removes a workitem from the current project and updates the changes on the server.
Parameters
workItem:IWorkItem — A WorkItem to be removed.
|
mx.rpc:AsyncToken — It returns a token on which success fault handlers can be attached. The resulting event contains the value object of the removed workitem.
|
removeWorkItemAt | () | method |
public function removeWorkItemAt(index:int):IWorkItem| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This method removes a workitem at a specified index from a collection of workitems. It removes the workitem locally and not from a server.
Parameters
index:int — Index of a workitem to be removed.
|
IWorkItem — It returns a reference to the removed workitem.
|
save | () | method |
public function save():mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation saves the current state of a project on a server. If the current state is successfully saved, the operation also refreshes the current object with the new value object returned from the server.
Returnsmx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains the value object of the saved project.
|
terminate | () | method |
public function terminate():mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation terminates the current project. If operation is successful, it refreshes the current object with a new value object returned by the server.
Returnsmx.rpc:AsyncToken — It returns a token on which success fault handlers can be attached. The resulting event contains the value object of the terminated project.
|
updateTitleAndSave | () | method |
public function updateTitleAndSave(member:IMember, title:String):mx.rpc:AsyncToken| Language Version: | ActionScript 3.0 |
| Product Version: | Project Management Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
This remote operation updates the tile of a member present in collection and submits the change to the server.
Parameters
member:IMember — The member to be removed from member collection.
| |
title:String — The title of the member.
|
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.
|
Mon Apr 10 2017, 12:28 PM -07:00