Package com.atlassian.greenhopper.web.rapid.view.workingdays

Class WorkingDaysResource

java.lang.Object

com.atlassian.greenhopper.web.AbstractResource

com.atlassian.greenhopper.web.rapid.view.workingdays.WorkingDaysResource

@Path("/rapidviewconfig/workingdays")
@Produces("application/json")
@Consumes("application/json")
public class WorkingDaysResource
extends AbstractResource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkingDaysResource.NonWorkingDayRequest
static class	WorkingDaysResource.TimeInPeriodResponse
static class	WorkingDaysResource.TimeZoneRequest

Field Summary

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

authenticationContext, log

Constructor Summary

Constructors

Constructor	Description
WorkingDaysResource(WorkingDaysHelper workingDaysHelper, WorkRateDataFactory workRateDataFactory, com.atlassian.jira.timezone.TimeZoneManager timeZoneManager, RapidViewService rapidViewService, SprintTimeRemainingService sprintTimeRemainingService)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	addNonWorkingDay(WorkingDaysResource.NonWorkingDayRequest nonWorkingDayRequest)	Adds an off day
jakarta.ws.rs.core.Response	getRates(Long rapidViewId, Long startDate, Long endDate)
jakarta.ws.rs.core.Response	getTimeInSprintPeriod(Long rapidViewId, Long startDate, Long endDate)	Calculates workdays in given period and time between today and startDate.
jakarta.ws.rs.core.Response	removeNonWorkingDay(WorkingDaysResource.NonWorkingDayRequest nonWorkingDayRequest)	Removes an off day
jakarta.ws.rs.core.Response	updateTimeZone(WorkingDaysResource.TimeZoneRequest timeZoneRequest)	Update a Subquery given its id and the id of the rapid view it belongs to
jakarta.ws.rs.core.Response	updateWeekDaysOff(WeekDaysModel weekDaysModel)	Update the weekdays marked as off

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

WorkingDaysResource

@Inject
public WorkingDaysResource(WorkingDaysHelper workingDaysHelper,
 WorkRateDataFactory workRateDataFactory,
 com.atlassian.jira.timezone.TimeZoneManager timeZoneManager,
 RapidViewService rapidViewService,
 SprintTimeRemainingService sprintTimeRemainingService)

Method Details

updateWeekDaysOff

@PUT
@Path("/weekdays")
public jakarta.ws.rs.core.Response updateWeekDaysOff(WeekDaysModel weekDaysModel)

Update the weekdays marked as off

updateTimeZone

@PUT
@Path("/timezone")
public jakarta.ws.rs.core.Response updateTimeZone(WorkingDaysResource.TimeZoneRequest timeZoneRequest)

Update a Subquery given its id and the id of the rapid view it belongs to

addNonWorkingDay

@POST
@Path("/nonworkingday/add")
public jakarta.ws.rs.core.Response addNonWorkingDay(WorkingDaysResource.NonWorkingDayRequest nonWorkingDayRequest)

Adds an off day

removeNonWorkingDay

@POST
@Path("/nonworkingday/remove")
public jakarta.ws.rs.core.Response removeNonWorkingDay(WorkingDaysResource.NonWorkingDayRequest nonWorkingDayRequest)

Removes an off day

getRates

@GET
@Path("/rates")
public jakarta.ws.rs.core.Response getRates(@QueryParam("rapidViewId")
 Long rapidViewId,
 @QueryParam("startDate")
 Long startDate,
 @QueryParam("endDate")
 Long endDate)

getTimeInSprintPeriod

@GET
@Path("/period")
public jakarta.ws.rs.core.Response getTimeInSprintPeriod(@QueryParam("rapidViewId")
 Long rapidViewId,
 @QueryParam("startDate")
 Long startDate,
 @QueryParam("endDate")
 Long endDate)

Calculates workdays in given period and time between today and startDate.

Parameters:

rapidViewId - id of Rapid Board

startDate - time of beginning of the period given in milliseconds

endDate - time of end of the period given in milliseconds

Returns:

Response containing workdays between startDate and endDate.

Since:

9.11 Also returns embedded object containing time to period start