com.adobe.solutions.prm.service
Interface WorkItemManagementService

public interface WorkItemManagementService

Manages the work item, work item is the single unit of work associated with a project. There can be many work items asscoiated with a project.

Method Summary

WorkItem	activateWorkItem(java.lang.String workItemId) Activates a given workItem.
void	addSupportingDocument(java.lang.String workItemId, DocumentTO supportingDoc) add supporting documents associated with the project
java.util.List	addTeamMember(java.lang.String workItemId, TeamMember member) Adds a team member to the work item
WorkItem	addWorkItem(java.lang.String projectId, WorkItem workItem) Adds/creates a child work item to an existing project.
WorkItem	createWorkItemFromTemplate(java.lang.String workItemId) Creates a copy of workitem using given workitem as template.
void	removeSupportingDocument(java.lang.String workItemId, DocumentTO supportingDoc) remove supporting documents associated with the project
java.util.List	removeTeamMember(java.lang.String workItemId, TeamMember member) removes a team member from the work item.
WorkItem	removeWorkItem(java.lang.String workItemId, java.lang.Boolean forceTerminate) Removes a given work item from a project
void	startScheduledWorkItem(java.lang.String workItemId) Used Internally by scheduler to start a scheduled project.
WorkItem	startWorkItem(java.lang.String workItemId) Starts a work item explicitly, if start workitem is called, workitem is immediately started.
WorkItem	terminateWorkItem(java.lang.String workItemId) Terminates given work item from a project
void	updateAssetThumbnail(java.lang.String workItemId, com.adobe.idp.Document thumbnail, java.lang.String thumbnailName, java.lang.String mimeType) Used Internally, Update Asset thumbnail for the workItem.
java.util.List	updateTeamMember(java.lang.String workItemId, TeamMember member) updates a team member in the work item.
WorkItem	updateWorkItem(WorkItem workItem) Updates a workitem.

Method Detail

addSupportingDocument

void addSupportingDocument(java.lang.String workItemId,
                           DocumentTO supportingDoc)
                           throws ProjectManagementException

add supporting documents associated with the project

Parameters:

workItemId - WorkItem Identifier

supportingDoc - supporting document to be added

Throws:

ProjectManagementException

removeSupportingDocument

void removeSupportingDocument(java.lang.String workItemId,
                              DocumentTO supportingDoc)
                              throws ProjectManagementException

remove supporting documents associated with the project

Parameters:

workItemId - WorkItem Identifier

supportingDoc - supporting document to be removed

Throws:

ProjectManagementException

addTeamMember

java.util.List addTeamMember(java.lang.String workItemId,
                             TeamMember member)
                             throws ProjectManagementException

Adds a team member to the work item

Parameters:

workItemId - WorkItem Identifier

member - member definition

Returns:

list of current Member

Throws:

ProjectManagementException

removeTeamMember

java.util.List removeTeamMember(java.lang.String workItemId,
                                TeamMember member)
                                throws ProjectManagementException

removes a team member from the work item.

Parameters:

workItemId - WorkItem Identifier

memeber - team member to be removed

Returns:

list of current Member

Throws:

ProjectManagementException

updateTeamMember

java.util.List updateTeamMember(java.lang.String workItemId,
                                TeamMember member)
                                throws ProjectManagementException

updates a team member in the work item.

Parameters:

workItemId - WorkItem Identifier

memeber - team member to be removed

Returns:

list of current Member

Throws:

ProjectManagementException

activateWorkItem

WorkItem activateWorkItem(java.lang.String workItemId)
                          throws ProjectManagementException

Activates a given workItem.

Parameters:

workItemId - identifier for the workItem

Returns:

Updated WorkItem Instance

Throws:

ProjectManagementException

startWorkItem

WorkItem startWorkItem(java.lang.String workItemId)
                       throws ProjectManagementException

Starts a work item explicitly, if start workitem is called, workitem is immediately started.

Parameters:

workItemId - Identifier for the work item

Returns:

Update WorkItem definition

Throws:

ProjectManagementException

addWorkItem

WorkItem addWorkItem(java.lang.String projectId,
                     WorkItem workItem)
                     throws ProjectManagementException

Adds/creates a child work item to an existing project.

Parameters:

projectId - Parent Project Id

workItem - work item definition

Throws:

ProjectManagementException

removeWorkItem

WorkItem removeWorkItem(java.lang.String workItemId,
                        java.lang.Boolean forceTerminate)
                        throws ProjectManagementException

Removes a given work item from a project

Parameters:

workItemId - Work item identifier

forceTerminate - if the workitem is running, true value will force the termination before deleting, else it will not delete.

Returns:

Throws:

ProjectManagementException

terminateWorkItem

WorkItem terminateWorkItem(java.lang.String workItemId)
                           throws ProjectManagementException

Terminates given work item from a project

Parameters:

workItemId - Work item identifier

Throws:

ProjectManagementException

updateWorkItem

WorkItem updateWorkItem(WorkItem workItem)
                        throws ProjectManagementException

Updates a workitem.

Parameters:

workItem - work item definition

Returns:

update workItem definition

Throws:

ProjectManagementException

startScheduledWorkItem

void startScheduledWorkItem(java.lang.String workItemId)
                            throws ProjectManagementException

Used Internally by scheduler to start a scheduled project.

Parameters:

workItemId -

Throws:

ProjectManagementException

updateAssetThumbnail

void updateAssetThumbnail(java.lang.String workItemId,
                          com.adobe.idp.Document thumbnail,
                          java.lang.String thumbnailName,
                          java.lang.String mimeType)

Used Internally, Update Asset thumbnail for the workItem.

Parameters:

workItemId - WorkItem Identifier

thumbnail - Thumbnail document

thumbnailName - Thumbnail Name

mimeType - Mime Type

createWorkItemFromTemplate

WorkItem createWorkItemFromTemplate(java.lang.String workItemId)
                                    throws ProjectManagementException

Creates a copy of workitem using given workitem as template.

Parameters:

workItemId - WorkItem ID, which is to be used as template. This call does not save the workitem, it only creates a copy (sanitized copy, removing older ids, references and runtime data) and return the copy.

Returns:

copy of workitem

Throws:

ProjectManagementException