Interface SprintQueryService
- All Known Implementing Classes:
SprintQueryServiceImpl
public interface SprintQueryService
Sprint querying functionality
-
Method Summary
Modifier and TypeMethodDescriptiongetClosedSprints
(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query jql) Backward compatible version ofgetClosedSprints(ApplicationUser, Query, boolean)
with includeHistoricSprints parameter set to truegetClosedSprints
(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query jql, boolean includeHistoricSprints) Get all closed sprints applicable to a given jql.com.atlassian.query.clause.Clause
Get a clause that includes all issues currently in an open sprintcom.atlassian.query.clause.Clause
Add a clause that includes all issues in at least one sprint (open or closed)com.atlassian.query.clause.Clause
Add a clause that excludes issues not in a future sprintcom.atlassian.query.clause.Clause
Get a clause that includes all issues currently in a closed sprintcom.atlassian.query.clause.Clause
Add a clause that includes for all issues not in any sprintServiceOutcome<io.atlassian.fugue.Pair<List<Sprint>,
Set<Long>>> getOpenSprintsAndBacklogProjects
(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query jql) Get all open sprints applicable to a given jql.ServiceOutcome<Set<com.atlassian.jira.project.Project>>
getProjects
(com.atlassian.jira.user.ApplicationUser user, Sprint sprint) Get all projects for a given sprintServiceOutcome<Map<Sprint,
Set<com.atlassian.jira.project.Project>>> getProjects
(com.atlassian.jira.user.ApplicationUser user, List<Sprint> sprints) Get all sprints and associated projects for a given jqlServiceOutcome<Set<com.atlassian.jira.project.Project>>
getProjectsOverrideSecurity
(com.atlassian.jira.user.ApplicationUser user, Sprint sprint) Get all projects for a given sprintServiceOutcome<Map<Sprint,
Set<com.atlassian.jira.project.Project>>> getProjectsOverrideSecurity
(com.atlassian.jira.user.ApplicationUser user, List<Sprint> sprints) Get all sprints and associated projects for a given jql Note: This method runs with security disabledcom.atlassian.query.clause.Clause
getSprintClause
(Sprint sprint) Add a clause that includes all issues of a given sprintgetSprints
(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query jql) Get all sprints applicable to a given jql.getSprints
(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query jql, boolean includeHistoricSprints) Get all sprints applicable to a given jql.com.atlassian.query.clause.Clause
getSprintsClause
(Collection<Sprint> sprints) Add a clause that includes all issues of a given sprints
-
Method Details
-
getSprints
@Nonnull ServiceOutcome<List<Sprint>> getSprints(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query jql) Get all sprints applicable to a given jql. This will check all issues in the given jql, returning all sprints assigned to the issues -
getSprints
@Nonnull ServiceOutcome<List<Sprint>> getSprints(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query jql, boolean includeHistoricSprints) Get all sprints applicable to a given jql. This will check all issues in the given jql, returning all sprints assigned to the issues- Parameters:
includeHistoricSprints
- if true Sprints previously assigned to issues are returned too
-
getClosedSprints
@Nonnull ServiceOutcome<List<Sprint>> getClosedSprints(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query jql) Backward compatible version ofgetClosedSprints(ApplicationUser, Query, boolean)
with includeHistoricSprints parameter set to true -
getClosedSprints
@Nonnull ServiceOutcome<List<Sprint>> getClosedSprints(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query jql, boolean includeHistoricSprints) Get all closed sprints applicable to a given jql. This will check all issues in the given jql, returning all closed sprints assigned to the issues.- Parameters:
includeHistoricSprints
- Tells if jql should use include sprints from issue change history or only value from sprint custom fieldjql
- A base jql used for searchuser
- A user requesting search. all permissions will be checked against this user
-
getOpenSprintsAndBacklogProjects
@Nonnull ServiceOutcome<io.atlassian.fugue.Pair<List<Sprint>,Set<Long>>> getOpenSprintsAndBacklogProjects(com.atlassian.jira.user.ApplicationUser user, com.atlassian.query.Query jql) Get all open sprints applicable to a given jql. This will check all issues in the given jql, returning all open sprints assigned to the issues -
getProjects
@Nonnull ServiceOutcome<Set<com.atlassian.jira.project.Project>> getProjects(com.atlassian.jira.user.ApplicationUser user, Sprint sprint) Get all projects for a given sprint -
getProjectsOverrideSecurity
@Nonnull ServiceOutcome<Set<com.atlassian.jira.project.Project>> getProjectsOverrideSecurity(com.atlassian.jira.user.ApplicationUser user, Sprint sprint) Get all projects for a given sprint -
getProjects
@Nonnull ServiceOutcome<Map<Sprint,Set<com.atlassian.jira.project.Project>>> getProjects(com.atlassian.jira.user.ApplicationUser user, List<Sprint> sprints) Get all sprints and associated projects for a given jql -
getProjectsOverrideSecurity
@Nonnull ServiceOutcome<Map<Sprint,Set<com.atlassian.jira.project.Project>>> getProjectsOverrideSecurity(com.atlassian.jira.user.ApplicationUser user, List<Sprint> sprints) Get all sprints and associated projects for a given jql Note: This method runs with security disabled -
getInOpenSprintClause
com.atlassian.query.clause.Clause getInOpenSprintClause()Get a clause that includes all issues currently in an open sprint -
getNotInOpenSprintClause
com.atlassian.query.clause.Clause getNotInOpenSprintClause()Get a clause that includes all issues currently in a closed sprint -
getInSprintClause
com.atlassian.query.clause.Clause getInSprintClause()Add a clause that includes all issues in at least one sprint (open or closed) -
getNotInSprint
com.atlassian.query.clause.Clause getNotInSprint()Add a clause that includes for all issues not in any sprint -
getSprintClause
Add a clause that includes all issues of a given sprint -
getSprintsClause
Add a clause that includes all issues of a given sprints -
getNotInFutureSprintClause
com.atlassian.query.clause.Clause getNotInFutureSprintClause()Add a clause that excludes issues not in a future sprint
-