com.atlassian.greenhopper.service.rapid
Interface RapidViewQueryService

All Known Implementing Classes:
RapidViewQueryServiceImpl

public interface RapidViewQueryService

Provides clauses and queries calculated from rapid views.


Method Summary
 ServiceOutcome<com.atlassian.query.Query> getActiveSprintsForPlanModeQuery(com.atlassian.crowd.embedded.api.User user, RapidView rapidView)
          Query used to find issues and active sprints for display in Plan mode.
 ServiceOutcome<com.atlassian.query.Query> getBacklogQuery(com.atlassian.crowd.embedded.api.User user, RapidView rapidView)
          Query used to find issues on the Plan mode.
 ServiceOutcome<java.util.List<Sprint>> getOpenSprints(com.atlassian.crowd.embedded.api.User user, RapidView rapidView)
          Get the list of open sprints for a given rapid view
 ServiceOutcome<com.atlassian.query.Query> getOpenSprintsQuery(com.atlassian.crowd.embedded.api.User user, RapidView rapidView)
          Query used to find open sprints for a given rapid board.
 ServiceOutcome<ClauseToAdd> getQuickFilterClause(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, java.util.Set<java.lang.Long> activeQuickFilterIds)
          Get the Quick Filter clause from a set of active quick filter ids
 ServiceOutcome<com.atlassian.query.Query> getRapidViewQuery(com.atlassian.crowd.embedded.api.User user, RapidView rapidView)
          Get the base rapid view query.
 ServiceOutcome<com.atlassian.query.Query> getScrumBoardQueryForVisibleIssues(com.atlassian.crowd.embedded.api.User user, RapidView rapidView)
          Attempts to build the query which will help determine if issues are viewable in the interface of a scrum board.
 ServiceOutcome<ClauseToAdd> getSprintFilterClause(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, java.util.Set<java.lang.Long> activeSprintIds)
          Get the Sprints clause from a set of active sprint ids
 ServiceOutcome<com.atlassian.query.clause.Clause> getStatusMappingClause(com.atlassian.crowd.embedded.api.User user, RapidView rapidView)
          Get the status mapping clause for a given RapidView
 ServiceOutcome<com.atlassian.query.Query> getWorkModeQuery(com.atlassian.crowd.embedded.api.User user, RapidView rapidView)
          Get the query for the work mode.
 ServiceOutcome<com.atlassian.query.Query> getWorkModeQuery(com.atlassian.crowd.embedded.api.User user, RapidView rapidView, Column column)
          Get the query for the work mode and a given column.
 

Method Detail

getRapidViewQuery

@NotNull
ServiceOutcome<com.atlassian.query.Query> getRapidViewQuery(com.atlassian.crowd.embedded.api.User user,
                                                                    RapidView rapidView)
Get the base rapid view query. This currently only includes the saved filter


getStatusMappingClause

@NotNull
ServiceOutcome<com.atlassian.query.clause.Clause> getStatusMappingClause(com.atlassian.crowd.embedded.api.User user,
                                                                                 RapidView rapidView)
Get the status mapping clause for a given RapidView


getWorkModeQuery

@NotNull
ServiceOutcome<com.atlassian.query.Query> getWorkModeQuery(com.atlassian.crowd.embedded.api.User 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

@NotNull
ServiceOutcome<com.atlassian.query.Query> getWorkModeQuery(com.atlassian.crowd.embedded.api.User 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

@NotNull
ServiceOutcome<com.atlassian.query.Query> getBacklogQuery(com.atlassian.crowd.embedded.api.User user,
                                                                  RapidView rapidView)
Query used to find issues on the Plan mode. This query consists of the saved filter, the mapped statuses, the plan mode query


getActiveSprintsForPlanModeQuery

@NotNull
ServiceOutcome<com.atlassian.query.Query> getActiveSprintsForPlanModeQuery(com.atlassian.crowd.embedded.api.User 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


getOpenSprintsQuery

@NotNull
ServiceOutcome<com.atlassian.query.Query> getOpenSprintsQuery(com.atlassian.crowd.embedded.api.User 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


getOpenSprints

@NotNull
ServiceOutcome<java.util.List<Sprint>> getOpenSprints(com.atlassian.crowd.embedded.api.User user,
                                                              RapidView rapidView)
Get the list of open sprints for a given rapid view


getQuickFilterClause

@NotNull
ServiceOutcome<ClauseToAdd> getQuickFilterClause(com.atlassian.crowd.embedded.api.User user,
                                                         RapidView rapidView,
                                                         java.util.Set<java.lang.Long> activeQuickFilterIds)
Get the Quick Filter clause from a set of active quick filter ids


getSprintFilterClause

@NotNull
ServiceOutcome<ClauseToAdd> getSprintFilterClause(com.atlassian.crowd.embedded.api.User user,
                                                          RapidView rapidView,
                                                          java.util.Set<java.lang.Long> activeSprintIds)
Get the Sprints clause from a set of active sprint ids


getScrumBoardQueryForVisibleIssues

@NotNull
ServiceOutcome<com.atlassian.query.Query> getScrumBoardQueryForVisibleIssues(com.atlassian.crowd.embedded.api.User 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


Copyright © 2007-2012 Atlassian. All Rights Reserved.