Package com.atlassian.greenhopper.web.rapid.plan

Interface PlanningModeService

All Known Implementing Classes:

PlanningModeServiceImpl

public interface PlanningModeService

PlanningMode related services

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PlanningModeService.CurrentSprints	A mapping from the current sprints to the issues which they contain.
static class	PlanningModeService.Result

Method Summary

Modifier and Type	Method	Description
ServiceOutcome<PlanningModeService.Result>	getBacklogIssuesAndSprintAssignment(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, Set<Long> activeQuickFilters)	Fetches all issues shown on the plan mode.
ServiceOutcome<SprintPlanEntry>	getCurrentSprintAndIssues(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, Long sprintId, Set<Long> activeQuickFilters)	Returns a representation of a single currently (open) sprint.
ServiceOutcome<PlanningModeService.CurrentSprints>	getCurrentSprintsAndIssues(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, Set<Long> activeQuickFilters)	Returns a representation of the current (open) sprints and their issues for the Plan mode of a Rapid Board.
ServiceOutcome<Iterable<com.atlassian.jira.issue.Issue>>	getTopRankedIssueInSprint(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, Set<Long> activeQuickFilters)	Get the top ranked issue in the current sprint for a given rapid view.

Method Details

getBacklogIssuesAndSprintAssignment

@Nonnull
ServiceOutcome<PlanningModeService.Result> getBacklogIssuesAndSprintAssignment(com.atlassian.jira.user.ApplicationUser user,
 RapidView rapidView,
 Set<Long> activeQuickFilters)

Fetches all issues shown on the plan mode. This includes all issues in an active sprint, but excludes epics

getTopRankedIssueInSprint

@Nonnull
ServiceOutcome<Iterable<com.atlassian.jira.issue.Issue>> getTopRankedIssueInSprint(com.atlassian.jira.user.ApplicationUser user,
 RapidView rapidView,
 Set<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

@Nonnull
ServiceOutcome<PlanningModeService.CurrentSprints> getCurrentSprintsAndIssues(com.atlassian.jira.user.ApplicationUser user,
 RapidView rapidView,
 Set<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

@Nonnull
ServiceOutcome<SprintPlanEntry> getCurrentSprintAndIssues(com.atlassian.jira.user.ApplicationUser user,
 RapidView rapidView,
 Long sprintId,
 Set<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