com.adobe.solutions.prm.service

# IProjectManagementCoreService - AS3 Project Management

Package | com.adobe.solutions.prm.service
Interface | public interface IProjectManagementCoreService
Implementors | ProjectManagementCoreService

Language Version: | ActionScript 3.0

Product Version: | Project Management Building Block 10.0

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

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

Public Methods

| Method | Defined By
--- | --- | ---
|  | activateProject(projectId:String):mx.rpc:AsyncToken This function activates a given project and its child projects or workItems. | IProjectManagementCoreService
|  | addLocalUser(projectId:String, user:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken This function adds a local user to a project. | IProjectManagementCoreService
|  | addProject(projectId:String, childProject:ProjectVO):mx.rpc:AsyncToken This function adds or creates a sub-project within an existing project. | IProjectManagementCoreService
|  | addSupportingDocument(projectId:String, supportingDocument:DocumentVO):mx.rpc:AsyncToken This function adds a supporting document to a project. | IProjectManagementCoreService
|  | addTeamMember(projectId:String, member:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken This function adds a team member to the project. | IProjectManagementCoreService
|  | createProject(project:ProjectVO):mx.rpc:AsyncToken This function creates a project, based on the project value object passed as input. | IProjectManagementCoreService
|  | createProjectFromTemplate(projectId:String):mx.rpc:AsyncToken This function creates a new project using an existing project as a template. | IProjectManagementCoreService
|  | postMessage(projectId:String, message:MessageVO):mx.rpc:AsyncToken This function adds a message to a project. | IProjectManagementCoreService
|  | removeLocalUser(projectId:String, user:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken This function removes a local user from a project. | IProjectManagementCoreService
|  | removeMessage(projectId:String, message:MessageVO):mx.rpc:AsyncToken This function removes a message from the project. | IProjectManagementCoreService
|  | removeProject(projectId:String, forceTerminate:Boolean):mx.rpc:AsyncToken This function removes a sub-project from an existing project. | IProjectManagementCoreService
|  | removeSupportingDocument(projectId:String, supportingDocument:DocumentVO):mx.rpc:AsyncToken This function removes a supporting document from a project. | IProjectManagementCoreService
|  | removeTeamMember(projectId:String, member:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken This function removes a team member from a project. | IProjectManagementCoreService
|  | startProject(projectId:String):mx.rpc:AsyncToken This function starts a project immediately. | IProjectManagementCoreService
|  | terminateProject(projectId:String):mx.rpc:AsyncToken This function terminates a project that is running or is active. | IProjectManagementCoreService
|  | updateLocalUser(projectId:String, user:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken This function updates a local user of a project. | IProjectManagementCoreService
|  | updateMessage(projectId:String, message:MessageVO):mx.rpc:AsyncToken This function updates an existing message of a project. | IProjectManagementCoreService
|  | updateProject(project:ProjectVO):mx.rpc:AsyncToken This function updates properties and schedule of a project. | IProjectManagementCoreService
|  | updateTeamMember(projectId:String, user:com.adobe.solutions.prm.vo:TeamMemberVO):mx.rpc:AsyncToken This function updates a team member of a project. | IProjectManagementCoreService

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.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00