Package com.atlassian.greenhopper.web.rapid.plan

Class PlanningModeResource

java.lang.Object

com.atlassian.greenhopper.web.AbstractResource

com.atlassian.greenhopper.web.rapid.plan.PlanningModeResource

@Path("xboard/plan")
@Produces("application/json")
@Consumes("application/json")
public class PlanningModeResource
extends AbstractResource

Resource for use in Planning Mode

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlanningModeResource.SprintActionsResponse

Field Summary

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

authenticationContext, log

Constructor Summary

Constructors

Constructor	Description
PlanningModeResource(RapidViewService rapidViewService, I18nFactoryService i18nFactoryService, com.atlassian.jira.bc.issue.IssueService issueService, ProjectHistoryService projectHistoryService, ProjectEntryTransformer projectEntryTransformer, PlanningModeHelper planningModeHelper, SprintService sprintService, EpicsHelper epicsHelper)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getBacklogData(Long rapidViewId, Set<Long> activeQuickFilters, String selectedProjectKey)	Returns the backlog data for the given rapid view and filtered by the given quick filters.
jakarta.ws.rs.core.Response	getBacklogEpics(Long rapidViewId)	Returns epics for the given rapid view
jakarta.ws.rs.core.Response	getBacklogIssue(Long rapidViewId, Long issueId, Set<Long> activeQuickFilters)
jakarta.ws.rs.core.Response	getBacklogVersions(Long rapidViewId)
jakarta.ws.rs.core.Response	getSprintActions(Long rapidViewId, Long sprintId)

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

PlanningModeResource

@Inject
public PlanningModeResource(RapidViewService rapidViewService,
 I18nFactoryService i18nFactoryService,
 com.atlassian.jira.bc.issue.IssueService issueService,
 ProjectHistoryService projectHistoryService,
 ProjectEntryTransformer projectEntryTransformer,
 PlanningModeHelper planningModeHelper,
 SprintService sprintService,
 EpicsHelper epicsHelper)

Method Details

getBacklogData

@GET
@Path("/backlog/data")
public jakarta.ws.rs.core.Response getBacklogData(@QueryParam("rapidViewId")
 Long rapidViewId,
 @QueryParam("activeQuickFilters")
 Set<Long> activeQuickFilters,
 @QueryParam("selectedProjectKey")
 String selectedProjectKey)

Returns the backlog data for the given rapid view and filtered by the given quick filters.

Parameters:

rapidViewId - The id of the rapid view for which to retrieve the backlog data

activeQuickFilters - A set of id's of active quick filters that will be applied to the returned backlog data

selectedProjectKey - which is used to re-order (or add) selected project to bottom of the queue.

Returns:

The backlog data for the given rapid view, filtered by the given quick filters.

getBacklogEpics

@GET
@Path("/backlog/epics")
public jakarta.ws.rs.core.Response getBacklogEpics(@QueryParam("rapidViewId")
 Long rapidViewId)

Returns epics for the given rapid view

Parameters:

rapidViewId - The id of the rapid view for which to retrieve epics

Returns:

A list of EpicData

getBacklogVersions

@GET
@Path("/backlog/versions")
public jakarta.ws.rs.core.Response getBacklogVersions(@QueryParam("rapidViewId")
 Long rapidViewId)

getBacklogIssue

@GET
@Path("/backlog/issue")
public jakarta.ws.rs.core.Response getBacklogIssue(@QueryParam("rapidViewId")
 Long rapidViewId,
 @QueryParam("issueId")
 Long issueId,
 @QueryParam("activeQuickFilters")
 Set<Long> activeQuickFilters)

getSprintActions

@GET
@Path("/sprints/actions")
public jakarta.ws.rs.core.Response getSprintActions(@QueryParam("rapidViewId")
 Long rapidViewId,
 @QueryParam("sprintId")
 Long sprintId)