com.adobe.solutions.prm.service
Interface ProjectManagementCoreService

public interface ProjectManagementCoreService

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

Method Summary

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

java.util.List addTeamMember(java.lang.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

java.util.List removeTeamMember(java.lang.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

java.util.List updateTeamMember(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String projectId,
                      java.lang.Boolean forceTerminate)
                      throws ProjectManagementException

Removes a project.

Parameters:

projectId - Project Identifier

Returns:

Removed Project Definition

Throws:

ProjectManagementException

postMessage

void postMessage(java.lang.String projectId,
                 Message msg)
                 throws ProjectManagementException

Adds a message to the project

Parameters:

msg - message

projectId - Project Identifier

Throws:

ProjectManagementException

removeMessage

void removeMessage(java.lang.String projectId,
                   Message msg)
                   throws ProjectManagementException

Removes a message from project

Parameters:

msg - message

projectId - Project Identifier

Throws:

ProjectManagementException

updateMessage

void updateMessage(java.lang.String projectId,
                   Message message)
                   throws ProjectManagementException

Updates the message

Parameters:

message - new message definition

Throws:

ProjectManagementException

startScheduledProject

void startScheduledProject(java.lang.String projectId)
                           throws ProjectManagementException

Used Internally by scheduler to start a scheduled workItem.

Parameters:

projectId -

Throws:

ProjectManagementException

terminateProject

Project terminateProject(java.lang.String projectId)
                         throws ProjectManagementException

Terminates a running/active project.

Parameters:

projectId - Project Identifier

Throws:

ProjectManagementException

markProjectDeadline

void markProjectDeadline(java.lang.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

java.util.List updateLocalUser(java.lang.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

java.util.List addLocalUser(java.lang.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

java.util.List removeLocalUser(java.lang.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