Package com.atlassian.greenhopper.web.rapid.sprint

Class SprintQueryResource

java.lang.Object

com.atlassian.greenhopper.web.AbstractResource

com.atlassian.greenhopper.web.rapid.sprint.SprintQueryResource

@Path("sprintquery/{rapidViewId}")
@Consumes("application/json")
@Produces("application/json")
public class SprintQueryResource
extends AbstractResource

Field Summary

Fields inherited from class com.atlassian.greenhopper.web.AbstractResource

authenticationContext, log

Constructor Summary

Constructors

Constructor	Description
SprintQueryResource(RapidViewService rapidViewService, SprintEntryFactory sprintEntryFactory, RapidViewSprintQueryService rapidViewSprintQueryService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getAllSprintsForRapidView(Long rapidViewId, boolean includeHistoricSprints, boolean includeFutureSprints)	Returns all the sprints for a given rapid view.

Methods inherited from class com.atlassian.greenhopper.web.AbstractResource

check, checkResult, createNoContentResponse, createOkResponse, createOkResponse, getUser, isGadgetRequest, nullSafe, response, responseWithoutAccessCheck

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SprintQueryResource

@Inject
public SprintQueryResource(RapidViewService rapidViewService,
 SprintEntryFactory sprintEntryFactory,
 RapidViewSprintQueryService rapidViewSprintQueryService)

Method Details

getAllSprintsForRapidView

@GET
public javax.ws.rs.core.Response getAllSprintsForRapidView(@PathParam("rapidViewId")
 Long rapidViewId,
 @QueryParam("includeHistoricSprints")
 boolean includeHistoricSprints,
 @QueryParam("includeFutureSprints")
 boolean includeFutureSprints)

Returns all the sprints for a given rapid view.

Parameters:

rapidViewId - The ID of a rapid view for which all sprints should be returned

includeHistoricSprints - if true sprints previously assigned to issues in the board will be returned too

includeFutureSprints - if true fututre sprints will be returned too

Returns:

A model containing all the sprints belonging to a certain rapid view.