com.adobe.solutions.prm.service
Interface ProjectManagementCoreService

public interface ProjectManagementCoreService

Defines core operation for project management like creation, updation, deletion.

Method Summary

Project	activateProject(String projectId) Activates a given project and its child projects/workItems
List	addLocalUser(String projectId, TeamMember user) For Internal User Only Add the local user in the project.
Project	addProject(String projectId, Project childProject) Adds/creates a sub project to already existing project.
void	addSupportingDocument(String projectId, DocumentTO supportingDoc) add supporting documents associated with the project
List	addTeamMember(String projectId, TeamMember member) Adds a team member to the project
Project	createProject(Project project) Creates given project.
Project	createProjectFromTemplate(String projectId) Creates a project using already existing project as a template
void	markProjectDeadline(String projectId) Used as a call back by scheduled trigger, should not be called directly.
void	postMessage(String projectId, Message msg) Adds a message to the project
List	removeLocalUser(String projectId, TeamMember user) For Internal User Only Removes the local user in the project.
void	removeMessage(String projectId, Message msg) Removes a message from project
Project	removeProject(String projectId, Boolean forceTerminate) Removes a project.
void	removeSupportingDocument(String projectId, DocumentTO supportingDoc) remove supporting documents associated with the project
List	removeTeamMember(String projectId, TeamMember member) removes a team member from the work item.
Project	startProject(String projectId) Starts a project explicitly, if start project is called, project is immediately started.
void	startScheduledProject(String projectId) Used Internally by scheduler to start a scheduled workItem.
Project	terminateProject(String projectId) Terminates a running/active project.
List	updateLocalUser(String projectId, TeamMember user) For Internal User Only Update the local user in the project.
void	updateMessage(String projectId, Message message) Updates the message
Project	updateProject(Project project) Updates a project's properties and its schedule.
List	updateTeamMember(String projectId, TeamMember member) updates a team member in the work item.

Method Detail

createProject

Project createProject(Project project)
                      throws ProjectManagementException

Creates given project.

Parameters:

project - project definition

Returns:

created project

Throws:

ProjectManagementException

createProjectFromTemplate

Project createProjectFromTemplate(String projectId)
                                  throws ProjectManagementException

Creates a project using already existing project as a template

Parameters:

projectId - Identifier for the project that is to be used as template

Returns:

copy of the project.

Throws:

ProjectManagementException

updateProject

Project updateProject(Project project)
                      throws ProjectManagementException

Updates a project's properties and its schedule. It does not update other associations or child relations.

Parameters:

project - Project's updated definition

Returns:

Updated Project

Throws:

ProjectManagementException

addSupportingDocument

void addSupportingDocument(String projectId,
                           DocumentTO supportingDoc)
                           throws ProjectManagementException

add supporting documents associated with the project

Parameters:

projectId - Project Identifier

supportingDoc - supporting document to be added

Throws:

ProjectManagementException

removeSupportingDocument

void removeSupportingDocument(String projectId,
                              DocumentTO supportingDoc)
                              throws ProjectManagementException

remove supporting documents associated with the project

Parameters:

projectId - Project Identifier

supportingDoc - supporting document to be removed

Throws:

ProjectManagementException

addTeamMember

List addTeamMember(String projectId,
                   TeamMember member)
                   throws ProjectManagementException

Adds a team member to the project

Parameters:

projectId - Project identifier

member - member definition

Returns:

list of current Member

Throws:

ProjectManagementException

removeTeamMember

List removeTeamMember(String projectId,
                      TeamMember member)
                      throws ProjectManagementException

removes a team member from the work item.

Parameters:

projectID - Project Identifier

memeber - team member to be removed

Returns:

list of current Member

Throws:

ProjectManagementException

updateTeamMember

List updateTeamMember(String projectId,
                      TeamMember member)
                      throws ProjectManagementException

updates a team member in the work item.

Parameters:

projectID - Project Identifier

memeber - team member to be removed

Returns:

list of current Member

Throws:

ProjectManagementException

activateProject

Project activateProject(String projectId)
                        throws ProjectManagementException

Activates a given project and its child projects/workItems

Parameters:

projectId - identifier for the project

Returns:

Activated Project

Throws:

ProjectManagementException

startProject

Project startProject(String projectId)
                     throws ProjectManagementException

Starts a project explicitly, if start project is called, project is immediately started. Its child project/workitems will be started as per the start date specified in the project definition.

Parameters:

projectId - Identifier for the project

Returns:

Update Project definition

Throws:

ProjectManagementException

addProject

Project addProject(String projectId,
                   Project childProject)
                   throws ProjectManagementException

Adds/creates a sub project to already existing project.

Parameters:

projectId - Parent project identifier

childProject - child project definition

Throws:

ProjectManagementException

removeProject

Project removeProject(String projectId,
                      Boolean forceTerminate)
                      throws ProjectManagementException

Removes a project.

Parameters:

projectId - Project Identifier

Returns:

Removed Project Definition

Throws:

ProjectManagementException

postMessage

void postMessage(String projectId,
                 Message msg)
                 throws ProjectManagementException

Adds a message to the project

Parameters:

msg - message

projectId - Project Identifier

Throws:

ProjectManagementException

removeMessage

void removeMessage(String projectId,
                   Message msg)
                   throws ProjectManagementException

Removes a message from project

Parameters:

msg - message

projectId - Project Identifier

Throws:

ProjectManagementException

updateMessage

void updateMessage(String projectId,
                   Message message)
                   throws ProjectManagementException

Updates the message

Parameters:

message - new message definition

Throws:

ProjectManagementException

startScheduledProject

void startScheduledProject(String projectId)
                           throws ProjectManagementException

Used Internally by scheduler to start a scheduled workItem.

Parameters:

projectId -

Throws:

ProjectManagementException

terminateProject

Project terminateProject(String projectId)
                         throws ProjectManagementException

Terminates a running/active project.

Parameters:

projectId - Project Identifier

Throws:

ProjectManagementException

markProjectDeadline

void markProjectDeadline(String projectId)
                         throws ProjectManagementException

Used as a call back by scheduled trigger, should not be called directly. It is called to mark the project deadlined.

Parameters:

projectId -

Throws:

ProjectManagementException

updateLocalUser

List updateLocalUser(String projectId,
                     TeamMember user)
                     throws ProjectManagementException

For Internal User Only Update the local user in the project.

Parameters:

projectId - Project Identifier

user - LocalUser

Returns:

List of current local users

Throws:

ProjectManagementException

addLocalUser

List addLocalUser(String projectId,
                  TeamMember user)
                  throws ProjectManagementException

For Internal User Only Add the local user in the project.

Parameters:

projectId - Project Identifier

user - LocalUser

Returns:

List of current local users

Throws:

ProjectManagementException

removeLocalUser

List removeLocalUser(String projectId,
                     TeamMember user)
                     throws ProjectManagementException

For Internal User Only Removes the local user in the project.

Parameters:

projectId - Project Identifier

user - LocalUser

Returns:

List of current local users

Throws:

ProjectManagementException