com.atlassian.greenhopper.service.timetracking
Interface WorklogHistoryService

All Superinterfaces:
GreenHopperCache
All Known Implementing Classes:
WorklogHistoryServiceImpl

public interface WorklogHistoryService
extends GreenHopperCache

The worklog history service is responsible for delivering data that is based on JIRA worklogs

Author:
ahennecke

Field Summary
static java.lang.String SERVICE
           
 
Method Summary
 java.lang.Long computeRemainingEstimateBeforeWorkStarted(com.atlassian.jira.issue.Issue issue, com.atlassian.crowd.embedded.api.User user, org.joda.time.Interval day)
           
 TimelineAnalysis computeTimetrackingAnalysis(java.util.List<com.atlassian.jira.issue.Issue> issues, com.atlassian.crowd.embedded.api.User user, org.joda.time.DateMidnight start, org.joda.time.DateMidnight end)
           
 WorklogTimeline computeTimetrackingHistory(java.util.List<com.atlassian.jira.issue.Issue> issues, com.atlassian.crowd.embedded.api.User user)
          Fetch a structured, chronological view of the work logged on an issue and the change of the remaining estimate.
 void flushCacheForIssue(com.atlassian.jira.issue.Issue issue)
          Removes the issue from the timeline cache.
 
Methods inherited from interface com.atlassian.greenhopper.manager.GreenHopperCache
flushCache
 

Field Detail

SERVICE

static final java.lang.String SERVICE
See Also:
Constant Field Values
Method Detail

computeTimetrackingHistory

WorklogTimeline computeTimetrackingHistory(java.util.List<com.atlassian.jira.issue.Issue> issues,
                                           com.atlassian.crowd.embedded.api.User user)
Fetch a structured, chronological view of the work logged on an issue and the change of the remaining estimate. The data structure looks like this:

Day of change => issueKey => values at the end of the day

The initial value for remaining estimate is set with the issue creation date.

No data is created for days where no changes were made.

Parameters:
issues - : The issues to be included
user - : The current user
Returns:
: Data structure with day-cumulative timetracking history

computeRemainingEstimateBeforeWorkStarted

java.lang.Long computeRemainingEstimateBeforeWorkStarted(com.atlassian.jira.issue.Issue issue,
                                                         com.atlassian.crowd.embedded.api.User user,
                                                         org.joda.time.Interval day)

computeTimetrackingAnalysis

TimelineAnalysis computeTimetrackingAnalysis(java.util.List<com.atlassian.jira.issue.Issue> issues,
                                             com.atlassian.crowd.embedded.api.User user,
                                             org.joda.time.DateMidnight start,
                                             org.joda.time.DateMidnight end)

flushCacheForIssue

void flushCacheForIssue(com.atlassian.jira.issue.Issue issue)
Removes the issue from the timeline cache.

Parameters:
issue - the issue


Copyright © 2007-2014 Atlassian. All Rights Reserved.