com.atlassian.jira.issue.worklog

Interface TimeTrackingIssueUpdater

All Known Implementing Classes:

DefaultTimeTrackingIssueUpdater

public interface TimeTrackingIssueUpdater

Used to update the remaining estimate and time spent fields on an Issue when creating, updating, or deleting Worklog's.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_ORIGINAL_WORKLOG_PARAMETER

Method Summary

Modifier and Type	Method and Description
void	updateIssueOnWorklogCreate(ApplicationUser user, Worklog worklog, Long newEstimate, boolean dispatchEvent) Will set the Worklog.getIssue()'s remaining estimate to the newEstimate and will increment the issues time spent by the Worklog.getTimeSpent().
void	updateIssueOnWorklogDelete(ApplicationUser user, Worklog worklog, Long newEstimate, boolean dispatchEvent) Will set the Worklog.getIssue()'s remaining estimate to the newEstimate and will decrement the issues time spent by the Worklog.getTimeSpent().
void	updateIssueOnWorklogUpdate(ApplicationUser user, Worklog originalWorklog, Worklog newWorklog, Long originalTimeSpent, Long newEstimate, boolean dispatchEvent) Will set the Worklog.getIssue()'s remaining estimate to the newEstimate and will decrement the issues time spent by the originalTimeSpent and then increment it by the Worklog.getTimeSpent().

Field Detail

EVENT_ORIGINAL_WORKLOG_PARAMETER

static final String EVENT_ORIGINAL_WORKLOG_PARAMETER

See Also:

Constant Field Values

Method Detail

updateIssueOnWorklogCreate

void updateIssueOnWorklogCreate(ApplicationUser user,
                                Worklog worklog,
                                Long newEstimate,
                                boolean dispatchEvent)

Will set the Worklog.getIssue()'s remaining estimate to the newEstimate and will increment the issues time spent by the Worklog.getTimeSpent().
If the newEstimate is null then the Issue's remaining estimate will not be changed.
This method will generate change items for the updated issue fields and will update the issue's last updated date.

Parameters:

user - the user performing the action, this user will be available in the dispatched event.

worklog - specifies the new amount of time spent and the issue to update.

newEstimate - if specified this value will over-write the Issue's remaining estimate.

dispatchEvent - if true then a EventType.ISSUE_WORKLOGGED_ID will be fired, otherwise no event will be fired.

updateIssueOnWorklogUpdate

void updateIssueOnWorklogUpdate(ApplicationUser user,
                                Worklog originalWorklog,
                                Worklog newWorklog,
                                Long originalTimeSpent,
                                Long newEstimate,
                                boolean dispatchEvent)

Will set the Worklog.getIssue()'s remaining estimate to the newEstimate and will decrement the issues time spent by the originalTimeSpent and then increment it by the Worklog.getTimeSpent().
If the newEstimate is null then the Issue's remaining estimate will not be changed.
This method will generate change items for the updated issue fields and will update the issue's last updated date.

Parameters:

user - the user performing the action, this user will be available in the dispatched event.

originalWorklog -

newWorklog -

originalTimeSpent - specifies the amount of time spent that was originally specified before the worklog update.

newEstimate - if specified this value will over-write the Issue's remaining estimate.

dispatchEvent - if true then a EventType.ISSUE_WORKLOG_UPDATED_ID will

updateIssueOnWorklogDelete

void updateIssueOnWorklogDelete(ApplicationUser user,
                                Worklog worklog,
                                Long newEstimate,
                                boolean dispatchEvent)

Will set the Worklog.getIssue()'s remaining estimate to the newEstimate and will decrement the issues time spent by the Worklog.getTimeSpent().
If the newEstimate is null then the Issue's remaining estimate will not be changed.
This method will generate change items for the updated issue fields, the removed worklog, and will update the issue's last updated date.

Parameters:

user - the user performing the action, this user will be available in the dispatched event.

worklog - specifies the amount of time spent to decrement and the issue to update.

newEstimate - if specified this value will over-write the Issue's remaining estimate.

dispatchEvent - if true then a EventType.ISSUE_WORKLOG_DELETED_ID will be fired, otherwise no event will be fired.