com.atlassian.greenhopper.service.rapid
Interface RapidViewLocationService

All Known Implementing Classes:

RapidViewLocationServiceImpl

public interface RapidViewLocationService

Allows the lookup of boards that an issue or sprint appears on.

Since:

v5.9.4

Method Summary

ServiceOutcome<BoardLocation>	getBoardLocationForIssue(com.atlassian.crowd.embedded.api.User user, com.atlassian.jira.issue.Issue issue, RapidView rapidView) Given the issue and a particular RapidView, returns the precise location of that issue on the RapidView.
ServiceOutcome<BoardLocation>	getBoardLocationForSprint(com.atlassian.crowd.embedded.api.User user, Sprint sprint) Given the sprint, returns the precise location of that sprint (on any RapidView).
ServiceOutcome<java.util.Set<RapidView>>	getRapidViewsForIssue(com.atlassian.crowd.embedded.api.User user, com.atlassian.jira.issue.Issue issue) Given the issue, look up all the Rapid Boards it appears on.
ServiceOutcome<java.util.Set<RapidView>>	getRapidViewsForSprint(com.atlassian.crowd.embedded.api.User user, java.lang.Long sprintId) Given the sprint, look up all the Rapid Boards it appears on.

Method Detail

getRapidViewsForIssue

@NotNull
ServiceOutcome<java.util.Set<RapidView>> getRapidViewsForIssue(com.atlassian.crowd.embedded.api.User user,
                                                                       com.atlassian.jira.issue.Issue issue)

Given the issue, look up all the Rapid Boards it appears on. Will only return Boards where the issue can be seen on the board in some mode. For Kanban Boards, this means that issues must appear in Work mode to qualify (taking into account the Work mode sub filter).

Calling this method may execute many Lucene queries.

Parameters:

user - the user performing the lookup

issue - the issue being looked up

Returns:

the outcome; the Rapid Boards that the issue appears on.

getRapidViewsForSprint

@NotNull
ServiceOutcome<java.util.Set<RapidView>> getRapidViewsForSprint(com.atlassian.crowd.embedded.api.User user,
                                                                        java.lang.Long sprintId)

Given the sprint, look up all the Rapid Boards it appears on.

Calling this method may execute many Lucene queries.

Parameters:

user - the user performing the lookup

sprintId - the ID of the sprint being looked up

Returns:

the outcome; the Rapid Boards that the sprint appears on.

getBoardLocationForIssue

@NotNull
ServiceOutcome<BoardLocation> getBoardLocationForIssue(com.atlassian.crowd.embedded.api.User user,
                                                               com.atlassian.jira.issue.Issue issue,
                                                               RapidView rapidView)

Given the issue and a particular RapidView, returns the precise location of that issue on the RapidView. This is used so that we can redirect the user to exactly where the issue is, and not just dropping them on the board.

Parameters:

user - the user performing the lookup

issue - the issue being looked up

rapidView - the board being looked up

Returns:

the outcome

getBoardLocationForSprint

@NotNull
ServiceOutcome<BoardLocation> getBoardLocationForSprint(com.atlassian.crowd.embedded.api.User user,
                                                                Sprint sprint)

Given the sprint, returns the precise location of that sprint (on any RapidView).

Parameters:

user - the user performing the lookup

sprint - the sprint being looked up

Returns:

the outcome