com.atlassian.greenhopper.web.rapid.plan
Interface PlanningModeService

All Known Implementing Classes:

PlanningModeServiceImpl

public interface PlanningModeService

PlanningMode related services

Nested Class Summary

static class

PlanningModeService.CurrentSprints A mapping from the current sprints to the issues which they contain.

Method Summary

ServiceOutcome<PlanningDataModel.OpenSprintEntry>	getCurrentSprintAndIssues(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, java.lang.Long sprintId, java.util.Set<java.lang.Long> activeQuickFilters) Returns a representation of a single currently (open) sprint.
ServiceOutcome<PlanningModeService.CurrentSprints>	getCurrentSprintsAndIssues(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, java.util.Set<java.lang.Long> activeQuickFilters) Returns a representation of the current (open) sprints and their issues for the Plan mode of a Rapid Board.
ServiceOutcome<java.lang.Iterable<com.atlassian.jira.issue.Issue>>	getTopRankedIssueInSprint(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, java.util.Set<java.lang.Long> activeQuickFilters) Get the top ranked issue in the current sprint for a given rapid view.

Method Detail

getTopRankedIssueInSprint

@NotNull
ServiceOutcome<java.lang.Iterable<com.atlassian.jira.issue.Issue>> getTopRankedIssueInSprint(com.atlassian.crowd.embedded.api.User user,
                                                                                                     RapidView rapidView,
                                                                                                     java.util.Set<java.lang.Long> activeQuickFilters)

Get the top ranked issue in the current sprint for a given rapid view. TODO This is an excellent candidate to return a Maybe

Parameters:

user -

rapidView -

activeQuickFilters -

Returns:

An Iterable of Issue, which contains either zero or one issues.

getCurrentSprintsAndIssues

@NotNull
ServiceOutcome<PlanningModeService.CurrentSprints> getCurrentSprintsAndIssues(com.atlassian.crowd.embedded.api.User user,
                                                                                      RapidView rapidView,
                                                                                      java.util.Set<java.lang.Long> activeQuickFilters)

Returns a representation of the current (open) sprints and their issues for the Plan mode of a Rapid Board.

Parameters:

user - the user

rapidView - the board

Returns:

the representation of current sprints

getCurrentSprintAndIssues

@NotNull
ServiceOutcome<PlanningDataModel.OpenSprintEntry> getCurrentSprintAndIssues(com.atlassian.crowd.embedded.api.User user,
                                                                                    RapidView rapidView,
                                                                                    java.lang.Long sprintId,
                                                                                    java.util.Set<java.lang.Long> activeQuickFilters)

Returns a representation of a single currently (open) sprint.

Parameters:

user - the user

rapidView - the board

sprintId - the id of the sprint to retrieve

Returns:

the representation of current sprints