com.atlassian.greenhopper.web.rapid.sprint
Class CompleteSprintResource

java.lang.Object
  com.atlassian.greenhopper.web.AbstractResource
      com.atlassian.greenhopper.web.rapid.sprint.CompleteSprintResource

public class CompleteSprintResource
extends AbstractResource

Field Summary

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

HTTP_HEADER_GREENHOPPER_GADGET, log

Constructor Summary

CompleteSprintResource(RapidViewService rapidViewService, SprintService sprintService, SprintPermissionService sprintPermissionService, CompleteSprintHelper completeSprintHelper, com.atlassian.jira.security.JiraAuthenticationContext authenticationContext, I18nFactoryService i18nFactoryService, SprintEntryFactory sprintEntryFactory, SprintHelper sprintHelper)

Method Summary

javax.ws.rs.core.Response	completeSprint(CompleteSprintRequest releaseRequest) Completes a sprint.
javax.ws.rs.core.Response	getCompleteModel(java.lang.Long sprintId, java.lang.Long rapidViewId) Returns a model containing details about the state of the sprint.

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

check, createErrorResponse, createFromServiceOutcome, createNoContentResponse, createOkResponse, createOkResponse, getUser, isGadgetRequest, nullSafe, response, wireAuthenticationContext, wireI18nFactoryService

Methods inherited from class java.lang.Object

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

Constructor Detail

CompleteSprintResource

public CompleteSprintResource(RapidViewService rapidViewService,
                              SprintService sprintService,
                              SprintPermissionService sprintPermissionService,
                              CompleteSprintHelper completeSprintHelper,
                              com.atlassian.jira.security.JiraAuthenticationContext authenticationContext,
                              I18nFactoryService i18nFactoryService,
                              SprintEntryFactory sprintEntryFactory,
                              SprintHelper sprintHelper)

Method Detail

getCompleteModel

public javax.ws.rs.core.Response getCompleteModel(java.lang.Long sprintId,
                                                  java.lang.Long rapidViewId)

Returns a model containing details about the state of the sprint.

Parameters:

rapidViewId - the ID of a rapid view

sprintId - the ID of the sprint

Returns:

A model containing the details of the sprint.

completeSprint

public javax.ws.rs.core.Response completeSprint(CompleteSprintRequest releaseRequest)

Completes a sprint. A completed sprint will no longer show up in plan or work mode.

Parameters:

releaseRequest - Contains the rapid view ID and sprint ID of the sprint that will be completed.

Returns:

A confirmation message if the sprint was successfully completed.