Package 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 Details

    • getRapidViewsForIssue

      @Nonnull ServiceOutcome<Set<RapidView>> getRapidViewsForIssue(com.atlassian.jira.user.ApplicationUser user, com.atlassian.jira.issue.Issue issue)
      Given the issue, look up the Rapid Boards it appears on. Search includes all the Rapid Boards meeting at least one of the following conditions:
      • query for the board explicitly mentions the given issue's project key,
      • the board is in the user's "recently viewed boards" (max number in this list is set in application properties; default max is 50)
      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

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

      @Nonnull ServiceOutcome<BoardLocation> getBoardLocationForIssue(com.atlassian.jira.user.ApplicationUser 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

      @Nonnull ServiceOutcome<BoardLocation> getBoardLocationForSprint(com.atlassian.jira.user.ApplicationUser 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