com.atlassian.greenhopper.web.rapid.sprint
Class SprintHelper

java.lang.Object
  com.atlassian.greenhopper.web.rapid.sprint.SprintHelper

@Service
public class SprintHelper
extends java.lang.Object

Contains helper methods to work with sprints

Nested Class Summary

static class

SprintHelper.FutureSprintMapping

Field Summary

static java.lang.String	DATE_FORMAT_MISMATCH_CONTEXT_ID
static int	MIN_SUGGESTIONS

Constructor Summary

SprintHelper()

Method Summary

ServiceOutcome<java.lang.Void>	addToNextFutureSprint(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, java.util.Map<Sprint,java.util.List<com.atlassian.jira.issue.Issue>> sprintToIssues, java.util.Set<com.atlassian.jira.issue.Issue> doneIssues, SprintHelper.FutureSprintMapping futureSprintMapping) Assign issues to the next future sprint.
ServiceOutcome<java.lang.Void>	addToNextFutureSprint(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, Sprint sprint, java.util.List<com.atlassian.jira.issue.Issue> issues, SprintHelper.FutureSprintMapping futureSprintMapping) Assigns issues of a sprint to the next future sprint.
ServiceOutcome<java.util.Map<Sprint,java.util.List<com.atlassian.jira.issue.Issue>>>	calculateCurrentSprintAssignment(com.atlassian.crowd.embedded.api.User user, java.util.List<com.atlassian.jira.issue.Issue> issues) Get a map from sprint to issues in the sprint.
ServiceOutcome<Sprint>	createUpdatedSprint(com.atlassian.crowd.embedded.api.User user, Sprint sprint, UpdateSprintRequest updateSprintRequest) Parses an update sprint request and creates a sprint object out of it
java.util.Set<com.atlassian.jira.issue.Issue>	findDoneIssues(RapidView rapidView, java.util.List<com.atlassian.jira.issue.Issue> issues) Finds all issues that are done according to the definition of done for the given rapid view.
ServiceOutcome<java.util.Set<Sprint>>	findSprintPickerAllMatches(com.atlassian.crowd.embedded.api.User user, java.util.Set<Sprint> suggestions, java.lang.String query, int maxResults, boolean excludeCompleted)
java.util.List<Sprint>	findSprintsByNameInHistory(com.atlassian.crowd.embedded.api.User user, java.lang.String query, int maxResults, boolean excludeCompleted)
java.lang.String	getBoardNameForSprint(com.atlassian.crowd.embedded.api.User user, Sprint sprint) Retrieves the board name associated with a sprint or a permission error if it is unavailable.
ServiceOutcome<SprintHelper.FutureSprintMapping>	getFutureSprintMapping(com.atlassian.crowd.embedded.api.User user, RapidView rapidView) Returns a mapping from each sprint to the next sprint for a given rapid view.
ServiceOutcome<com.atlassian.jira.util.lang.Pair<org.joda.time.DateTime,org.joda.time.DateTime>>	parseDates(com.atlassian.crowd.embedded.api.User user, java.lang.String startDateString, java.lang.String endDateString) Parses a sprint start and end date.
ServiceOutcome<java.lang.Void>	removeFromCurrentSprints(com.atlassian.crowd.embedded.api.User user, java.util.Map<Sprint,java.util.List<com.atlassian.jira.issue.Issue>> sprintToIssues) Removes issues from their current sprint

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATE_FORMAT_MISMATCH_CONTEXT_ID

public static final java.lang.String DATE_FORMAT_MISMATCH_CONTEXT_ID

See Also:

Constant Field Values

MIN_SUGGESTIONS

public static final int MIN_SUGGESTIONS

See Also:

Constant Field Values

Constructor Detail

SprintHelper

public SprintHelper()

Method Detail

createUpdatedSprint

public ServiceOutcome<Sprint> createUpdatedSprint(com.atlassian.crowd.embedded.api.User user,
                                                  Sprint sprint,
                                                  UpdateSprintRequest updateSprintRequest)

Parses an update sprint request and creates a sprint object out of it

parseDates

public ServiceOutcome<com.atlassian.jira.util.lang.Pair<org.joda.time.DateTime,org.joda.time.DateTime>> parseDates(com.atlassian.crowd.embedded.api.User user,
                                                                                                                   java.lang.String startDateString,
                                                                                                                   java.lang.String endDateString)

Parses a sprint start and end date. null and "None" values are converted to null. Other non parseable values result in an error

Returns:

a pair of dates, either or both of which can be null

calculateCurrentSprintAssignment

public ServiceOutcome<java.util.Map<Sprint,java.util.List<com.atlassian.jira.issue.Issue>>> calculateCurrentSprintAssignment(com.atlassian.crowd.embedded.api.User user,
                                                                                                                             java.util.List<com.atlassian.jira.issue.Issue> issues)

Get a map from sprint to issues in the sprint.

getFutureSprintMapping

public ServiceOutcome<SprintHelper.FutureSprintMapping> getFutureSprintMapping(com.atlassian.crowd.embedded.api.User user,
                                                                               RapidView rapidView)

Returns a mapping from each sprint to the next sprint for a given rapid view. This mapping can be used to figure out where to add issues to when removing them from a sprint or when a sprint is completed.

removeFromCurrentSprints

public ServiceOutcome<java.lang.Void> removeFromCurrentSprints(com.atlassian.crowd.embedded.api.User user,
                                                               java.util.Map<Sprint,java.util.List<com.atlassian.jira.issue.Issue>> sprintToIssues)

Removes issues from their current sprint

findSprintPickerAllMatches

public ServiceOutcome<java.util.Set<Sprint>> findSprintPickerAllMatches(com.atlassian.crowd.embedded.api.User user,
                                                                        java.util.Set<Sprint> suggestions,
                                                                        java.lang.String query,
                                                                        int maxResults,
                                                                        boolean excludeCompleted)

findDoneIssues

public java.util.Set<com.atlassian.jira.issue.Issue> findDoneIssues(RapidView rapidView,
                                                                    java.util.List<com.atlassian.jira.issue.Issue> issues)

Finds all issues that are done according to the definition of done for the given rapid view.

addToNextFutureSprint

public ServiceOutcome<java.lang.Void> addToNextFutureSprint(com.atlassian.crowd.embedded.api.User user,
                                                            RapidView rapidView,
                                                            Sprint sprint,
                                                            java.util.List<com.atlassian.jira.issue.Issue> issues,
                                                            SprintHelper.FutureSprintMapping futureSprintMapping)

Assigns issues of a sprint to the next future sprint. All issues are ranked to the top to ensure they are the first issues in that sprint

addToNextFutureSprint

public ServiceOutcome<java.lang.Void> addToNextFutureSprint(com.atlassian.crowd.embedded.api.User user,
                                                            RapidView rapidView,
                                                            java.util.Map<Sprint,java.util.List<com.atlassian.jira.issue.Issue>> sprintToIssues,
                                                            java.util.Set<com.atlassian.jira.issue.Issue> doneIssues,
                                                            SprintHelper.FutureSprintMapping futureSprintMapping)

Assign issues to the next future sprint. Done issues will be ignored

getBoardNameForSprint

public java.lang.String getBoardNameForSprint(com.atlassian.crowd.embedded.api.User user,
                                              Sprint sprint)

Retrieves the board name associated with a sprint or a permission error if it is unavailable.

Parameters:

user - the user

sprint - the sprint

Returns:

the board name

findSprintsByNameInHistory

public java.util.List<Sprint> findSprintsByNameInHistory(com.atlassian.crowd.embedded.api.User user,
                                                         java.lang.String query,
                                                         int maxResults,
                                                         boolean excludeCompleted)