Interface RapidViewQueryService

All Known Implementing Classes:
RapidViewQueryServiceImpl

public interface RapidViewQueryService
Provides clauses and queries calculated from rapid views.
  • Method Details

    • getRapidViewQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getRapidViewQuery(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Get the base rapid view query. This currently only includes the saved filter
    • getStatusMappingClause

      @Nonnull ServiceOutcome<com.atlassian.query.clause.Clause> getStatusMappingClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Get the status mapping clause for a given RapidView
    • getMappedRapidViewQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getMappedRapidViewQuery(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Get the base rapid view query plus the statuses which are mapped.
    • getWorkModeQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getWorkModeQuery(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Get the query for the work mode. This query will contain the savedFilter, the work mode subquery and the set of mapped statuses
    • getWorkModeQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getWorkModeQuery(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, Column column)
      Get the query for the work mode and a given column. This query will contain the savedFilter, the work mode subquery and the set of mapped statuses of the given column
    • getBacklogQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getBacklogQuery(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Query used to find issues on the Plan mode without the subtasks This query consists of the saved filter, the mapped statuses, the plan mode query. The epics are filtered out.
    • getBacklogQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getBacklogQuery(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, boolean withSubtasks)
      Query used to find issues on the Plan mode. This query consists of the saved filter, the mapped statuses, the plan mode query. The epics are filtered out.
    • getActiveSprintsForPlanModeQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getActiveSprintsForPlanModeQuery(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Query used to find issues and active sprints for display in Plan mode. This query consists of the saved filter, the mapped statuses, the plan mode active sprints query
    • getPlanModeIssuesQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getPlanModeIssuesQuery(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Finds all issues for the plan mode. All issues in active sprints and not done issues otherwise. Excludes epics. This query consists of the saved filter, the mapped statuses all issues not done or in an active sprint
    • getOpenSprintsQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getOpenSprintsQuery(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Query used to find open sprints for a given rapid board. The query consists of the saved filter, the mapped statuses and the open sprints clause
    • getOpenSprintQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getOpenSprintQuery(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, Long sprintId)
      Query used to find an open sprint for a given rapid board. The query consists of the saved filter, the mapped statuses and a clause to check if the given sprintId is an open sprint
    • getOpenSprintsAndBacklogProjects

      @Nonnull ServiceOutcome<io.atlassian.fugue.Pair<List<Sprint>,Set<Long>>> getOpenSprintsAndBacklogProjects(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Get the list of open sprints for a given rapid view
    • getQuickFilterClause

      @Nonnull ServiceOutcome<ClauseToAdd> getQuickFilterClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, Set<Long> activeQuickFilterIds)
      Get the Quick Filter clause from a set of active quick filter ids
    • getSprintFilterClause

      @Nonnull ServiceOutcome<ClauseToAdd> getSprintFilterClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, Set<Long> activeSprintIds)
      Get the Sprints clause from a set of active sprint ids
    • getKanbanBacklogFilterClause

      @Nonnull ServiceOutcome<ClauseToAdd> getKanbanBacklogFilterClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Returns:
      the clause for filtering out issues that have status mapped in KanbanBacklogColumn
    • getKanbanDoneColumnFilterClause

      @Nonnull ServiceOutcome<ClauseToAdd> getKanbanDoneColumnFilterClause(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
    • getScrumBoardQueryForVisibleIssues

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getScrumBoardQueryForVisibleIssues(com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Attempts to build the query which will help determine if issues are viewable in the interface of a scrum board.
      Parameters:
      user - the user
      rapidView - the rapid view
      Returns:
      the query
    • getFullRapidViewQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getFullRapidViewQuery(@Nullable com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Returns:
      the full query for rapid view which consist of query from from rapid view filter, status mapping clause. In case of Scrum board query filters epics.
    • getRapidViewBacklogQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getRapidViewBacklogQuery(@Nullable com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Returns:
      the query for issues in rapid view's backlog which means all undone issues that are not assigned to any future or active sprint.
    • getSprintQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getSprintQuery(@Nullable com.atlassian.jira.user.ApplicationUser user, Sprint sprint)
      Returns:
      the query for issues in sprint but in the context of given board.
    • getSprintQueryInBoardContext

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getSprintQueryInBoardContext(@Nullable com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, Sprint sprint)
      Returns:
      the query for issues in sprint but in the context of given board.
    • getEpicQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getEpicQuery(@Nullable com.atlassian.jira.user.ApplicationUser user, Epic epic)
      Returns:
      the query for issues in epic but in the context of given board.
    • getEpicQueryInBoardContext

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getEpicQueryInBoardContext(@Nullable com.atlassian.jira.user.ApplicationUser user, RapidView rapidView, Epic epic)
      Returns:
      the query for issues in epic but in the context of given board.
    • getIssuesWithoutEpicQuery

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getIssuesWithoutEpicQuery(@Nullable com.atlassian.jira.user.ApplicationUser user)
      Returns:
      the query for issues that are not assigned to any epic.
    • getIssuesWithoutEpicQueryInBoardContext

      @Nonnull ServiceOutcome<com.atlassian.query.Query> getIssuesWithoutEpicQueryInBoardContext(@Nullable com.atlassian.jira.user.ApplicationUser user, RapidView rapidView)
      Returns:
      the query for issues that are not assigned to any epic.
    • joinQueries

      @Nonnull com.atlassian.query.Query joinQueries(com.atlassian.query.Query queryA, @Nullable com.atlassian.query.Query queryB)
      Joins two queries. Ordering of the second query has higher priority.