public interface

TimeTrackingIssueUpdater

com.atlassian.jira.issue.worklog.TimeTrackingIssueUpdater
Known Indirect Subclasses

Class Overview

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

Summary

Constants
String EVENT_ORIGINAL_WORKLOG_PARAMETER
Public Methods
void updateIssueOnWorklogCreate(User user, Worklog worklog, Long newEstimate, boolean dispatchEvent)
Will set the getIssue()'s remaining estimate to the newEstimate and will increment the issues time spent by the getTimeSpent().
void updateIssueOnWorklogDelete(User user, Worklog worklog, Long newEstimate, boolean dispatchEvent)
Will set the getIssue()'s remaining estimate to the newEstimate and will decrement the issues time spent by the getTimeSpent().
void updateIssueOnWorklogUpdate(User user, Worklog originalWorklog, Worklog newWorklog, Long originalTimeSpent, Long newEstimate, boolean dispatchEvent)
Will set the getIssue()'s remaining estimate to the newEstimate and will decrement the issues time spent by the originalTimeSpent and then increment it by the getTimeSpent().

Constants

public static final String EVENT_ORIGINAL_WORKLOG_PARAMETER

Constant Value: "originalworklog"

Public Methods

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

Will set the getIssue()'s remaining estimate to the newEstimate and will increment the issues time spent by the 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 ISSUE_WORKLOGGED_ID will be fired, otherwise no event will be fired.

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

Will set the getIssue()'s remaining estimate to the newEstimate and will decrement the issues time spent by the 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 ISSUE_WORKLOG_DELETED_ID will be fired, otherwise no event will be fired.

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

Will set the getIssue()'s remaining estimate to the newEstimate and will decrement the issues time spent by the originalTimeSpent and then increment it by the 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.
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 ISSUE_WORKLOG_UPDATED_ID will