com.adobe.solutions.prm.handler
Interface WorkItemCallback

public interface WorkItemCallback

This interface provides call back definition for work item. A WorkItemFlowHandler implementation must invoke appropriate callbacks with respect to events generated during work item flow life cycle Almost all call backs require unique identifier for work item. It is the responsibility of the WorkItemFlowHandler implementation, to make sure that work item id is gets associated with the work flow item instance. If it is not possible for WorkItemFlowHandler to associate work item id with work flow item instance id, then the implementation must query project management building block to retrieve the work item associated with instance id.

Method Summary

void	handleAssetUpdate(String workItemId, com.adobe.livecycle.content.File content, String version) whenever an asset is updated during work item flow, this callback can be used.
void	handleScheduleChange(String workItemId, Date endDate) This call back is used whenever a deadline is extended for underlying work item flow.
void	handleStateChange(String workItemId, String instanceId, String state, String status, Map context) Handles the work item flow completion.
void	handleStatusChange(String workItemId, String status, Map context) Handles the status change of the work item flow.
void	handleTeamMemberAddition(String workItemId, TeamMember member) Any member or participant addition to work item flow is handled by this call back.
void	handleTeamMemberDeletion(String workItemId, TeamMember member) Any member or participant deletion to work item flow is handled by this call back.

Method Detail

handleStatusChange

void handleStatusChange(String workItemId,
                        String status,
                        Map context)
                        throws ProjectManagementException

Handles the status change of the work item flow. Work item flow can have various intermediate statuses, whenever status is changed. WorkItemFlowHandler implementation invoke this call back.

Parameters:

workItemId - unique identifier for work item. It is the responsibility of the WorkItemFlowHandler implementation, to make sure that work item id is gets associated with the work flow item instance.

status - Status of the work item flow. This can be any custom defined status, as defined by work item flow implementation

context - any key value pair to pass additional information to callback handler, optional

Throws:

ProjectManagementException

handleTeamMemberAddition

void handleTeamMemberAddition(String workItemId,
                              TeamMember member)
                              throws ProjectManagementException

Any member or participant addition to work item flow is handled by this call back.

Parameters:

workItemId - unique identifier for work item.

member - member information

Throws:

ProjectManagementException

handleTeamMemberDeletion

void handleTeamMemberDeletion(String workItemId,
                              TeamMember member)
                              throws ProjectManagementException

Any member or participant deletion to work item flow is handled by this call back.

Parameters:

workItemId - unique identifier for work item.

member - member information

Throws:

ProjectManagementException

handleAssetUpdate

void handleAssetUpdate(String workItemId,
                       com.adobe.livecycle.content.File content,
                       String version)
                       throws ProjectManagementException

whenever an asset is updated during work item flow, this callback can be used.

Parameters:

workItemId - unique identifier for work item.

content - updated content

version - version of the content

Throws:

ProjectManagementException

handleStateChange

void handleStateChange(String workItemId,
                       String instanceId,
                       String state,
                       String status,
                       Map context)
                       throws ProjectManagementException

Handles the work item flow completion.

Parameters:

workItemId - unique identifier for work item.

instanceId - unique identifier for work flow instance, must be passed is current state is IN_PROGRESS.

state - Completion State of the work item flow, must map to one of the predefined states.

status - This can be any custom defined status, as defined by work item flow implementation

context - any key value pair to pass additional information to callback handler, optional

Throws:

ProjectManagementException

handleScheduleChange

void handleScheduleChange(String workItemId,
                          Date endDate)
                          throws ProjectManagementException

This call back is used whenever a deadline is extended for underlying work item flow.

Parameters:

workItemId - unique identifier for work item.

endDate - End date of the work item flow

Throws:

ProjectManagementException