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.services.impl 

ProjectManagementCoreService  - AS3 Project Management

Packagecom.adobe.solutions.prm.services.impl
Classpublic class ProjectManagementCoreService
InheritanceProjectManagementCoreService Inheritance Object
Implements IProjectManagementCoreService

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

This class defines core operation for project management like, create, update, and delete.



Public Properties
 PropertyDefined By
  channelSet : ChannelSet
Channel set for remote operation calls.
ProjectManagementCoreService
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
  
The constructor for ProjectManagementCoreService class.
ProjectManagementCoreService
  
This function activates a given project and its child projects or workItems.
ProjectManagementCoreService
  
This function adds a local user to a project.
ProjectManagementCoreService
  
addProject(projectId:String, childProject:ProjectVO):mx.rpc:AsyncToken
This function adds or creates a sub-project within an existing project.
ProjectManagementCoreService
  
This function adds a supporting document to a project.
ProjectManagementCoreService
  
This function adds a team member to the project.
ProjectManagementCoreService
  
This function creates a project, based on the project value object passed as input.
ProjectManagementCoreService
  
This function creates a new project using an existing project as a template.
ProjectManagementCoreService
 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
  
This function adds a message to a project.
ProjectManagementCoreService
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
This function removes a local user from a project.
ProjectManagementCoreService
  
This function removes a message from the project.
ProjectManagementCoreService
  
removeProject(projectId:String, forceTerminate:Boolean):mx.rpc:AsyncToken
This function removes a sub-project from an existing project.
ProjectManagementCoreService
  
This function removes a supporting document from a project.
ProjectManagementCoreService
  
This function removes a team member from a project.
ProjectManagementCoreService
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
This function starts a project immediately.
ProjectManagementCoreService
  
This function terminates a project that is running or is active.
ProjectManagementCoreService
 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
  
This function updates a local user of a project.
ProjectManagementCoreService
  
This function updates an existing message of a project.
ProjectManagementCoreService
  
This function updates properties and schedule of a project.
ProjectManagementCoreService
  
This function updates a team member of a project.
ProjectManagementCoreService
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail

channelSet

property
channelSet:ChannelSet

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

Channel set for remote operation calls.



Implementation
    public function get channelSet():ChannelSet
    public function set channelSet(value:ChannelSet):void
Constructor Detail

ProjectManagementCoreService

()Constructor
public function ProjectManagementCoreService()

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

The constructor for ProjectManagementCoreService class.

Method Detail

activateProject

()method
public function activateProject(projectId:String):mx.rpc:AsyncToken

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

This function activates a given project and its child projects or workItems.

Parameters

projectId:String — The identifier of the project to be activated.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a value object of the activated project.

addLocalUser

()method 
public function addLocalUser(projectId:String, user:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken

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

This function adds a local user to a project.

Parameters

projectId:String — The identifier of the project to which a local user are to be added.
 
user:com.adobe.solutions.prm.vo:TeamMemberVO — An instance of a local user that is to be added.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains the list of local users associated with the project.

addProject

()method 
public function addProject(projectId:String, childProject:ProjectVO):mx.rpc:AsyncToken

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

This function adds or creates a sub-project within an existing project.

Parameters

projectId:String — The identifier of the project to which a child project is to be added.
 
childProject:ProjectVO — Child project to be added.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a value object of the added project.

addSupportingDocument

()method 
public function addSupportingDocument(projectId:String, supportingDocument:DocumentVO):mx.rpc:AsyncToken

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

This function adds a supporting document to a project.

Parameters

projectId:String — The identifier of the project to which a supporting document is to be added.
 
supportingDocument:DocumentVO — An instance of supportingDocument.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

addTeamMember

()method 
public function addTeamMember(projectId:String, member:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken

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

This function adds a team member to the project.

Parameters

projectId:String — Identifier of the project to which team member will be added.
 
member:com.adobe.solutions.prm.vo:TeamMemberVO — An instance of TeamMember.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a list of the team members associated with the project.

createProject

()method 
public function createProject(project:ProjectVO):mx.rpc:AsyncToken

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

This function creates a project, based on the project value object passed as input.

Parameters

project:ProjectVO — The project value object based on which a new project is to be created.

Returns
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 newly created project.

createProjectFromTemplate

()method 
public function createProjectFromTemplate(projectId:String):mx.rpc:AsyncToken

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

This function creates a new project using an existing project as a template.

Parameters

projectId:String — The identifier for the project to be used as a template.

Returns
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 newly created project.

postMessage

()method 
public function postMessage(projectId:String, message:MessageVO):mx.rpc:AsyncToken

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

This function adds a message to a project.

Parameters

projectId:String — The identifier of a project to which a message is to be added.
 
message:MessageVO — An instance of message to be added.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

removeLocalUser

()method 
public function removeLocalUser(projectId:String, user:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken

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

This function removes a local user from a project.

Parameters

projectId:String — The identifier of the project from which a local user is to be removed.
 
user:com.adobe.solutions.prm.vo:TeamMemberVO — An instance of the local user that is to be removed.

Returns
mx.rpc:AsyncToken — It returns a token on which success on fault handlers can be attached. The resulting event contains the list of local users associated with the project.

removeMessage

()method 
public function removeMessage(projectId:String, message:MessageVO):mx.rpc:AsyncToken

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

This function removes a message from the project.

Parameters

projectId:String — The identifier of the project, from which a message is to be removed.
 
message:MessageVO — An instance of message to be removed.

Returns
mx.rpc:AsyncToken — It returns a token on which success on fault handlers can be attached.

removeProject

()method 
public function removeProject(projectId:String, forceTerminate:Boolean):mx.rpc:AsyncToken

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

This function removes a sub-project from an existing project.

Parameters

projectId:String — The identifier of the sub-project to be removed.
 
forceTerminate:Boolean — If this Boolean flag is set to True, the system terminates the workflow running in that project.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a value object of the removed project.

removeSupportingDocument

()method 
public function removeSupportingDocument(projectId:String, supportingDocument:DocumentVO):mx.rpc:AsyncToken

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

This function removes a supporting document from a project.

Parameters

projectId:String — The identifier of the project from which a supporting document is to be removed.
 
supportingDocument:DocumentVO — An instance of supportingDocument.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

removeTeamMember

()method 
public function removeTeamMember(projectId:String, member:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken

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

This function removes a team member from a project.

Parameters

projectId:String — The identifier of the project from which a team member is to be removed.
 
member:com.adobe.solutions.prm.vo:TeamMemberVO — An instance of TeamMember.

Returns
mx.rpc:AsyncToken — token on which success/fault handlers can be attached. The result event contains the list of team members associated with the project.

startProject

()method 
public function startProject(projectId:String):mx.rpc:AsyncToken

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

This function starts a project immediately. The child project or workitems are started as per the start date specified in the project definition.

Parameters

projectId:String — The identifier of the project to be started.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a value object of the started project.

terminateProject

()method 
public function terminateProject(projectId:String):mx.rpc:AsyncToken

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

This function terminates a project that is running or is active.

Parameters

projectId:String — The identifier of the project to be terminated.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains the reference to the terminated project.

updateLocalUser

()method 
public function updateLocalUser(projectId:String, user:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken

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

This function updates a local user of a project.

Parameters

projectId:String — The identifier of the project, local user of which is to be updated.
 
user:com.adobe.solutions.prm.vo:TeamMemberVO — An instance of a local user with updated values.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a list of local users associated with the project.

updateMessage

()method 
public function updateMessage(projectId:String, message:MessageVO):mx.rpc:AsyncToken

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

This function updates an existing message of a project.

Parameters

projectId:String — The identifier of the project, messages of which are to be updated.
 
message:MessageVO — An instance of message, with updated values.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

updateProject

()method 
public function updateProject(project:ProjectVO):mx.rpc:AsyncToken

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

This function updates properties and schedule of a project. It does not update other associations or child relations of the project.

Parameters

project:ProjectVO — A project value object, with the updated values.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains a value object of the updated project.

updateTeamMember

()method 
public function updateTeamMember(projectId:String, user:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken

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

This function updates a team member of a project.

Parameters

projectId:String — The identifier of the project, team member of which is to be updated.
 
user:com.adobe.solutions.prm.vo:TeamMemberVO — An instance of a team member.

Returns
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains the list of team members associated with the project.