Package com.atlassian.jira.gadgets.system

Class AverageAgeChartResource

java.lang.Object

com.atlassian.jira.gadgets.system.AbstractResource

com.atlassian.jira.gadgets.system.SearchQueryBackedResource

com.atlassian.jira.gadgets.system.AverageAgeChartResource

@Path("/averageage")
@Produces("application/json")
public class AverageAgeChartResource
extends SearchQueryBackedResource

REST endpoint to validate and retreive a Average Age chart.

Since:

v4.0

Field Summary

Fields inherited from class com.atlassian.jira.gadgets.system.SearchQueryBackedResource

authenticationContext, chartUtils, permissionManager, QUERY_STRING, searchService

Constructor Summary

Constructors

Constructor	Description
AverageAgeChartResource(ChartFactory chartFactory, ChartUtils chartUtils, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, SearchService searchService, VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, TimeZoneManager timeZoneManager)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	generateChart(javax.servlet.http.HttpServletRequest request, String queryString, String days, String periodName, boolean returnData, int width, int height, boolean inline)	Generate an Average Age Chart and returns a simple bean containing all relievent information
javax.ws.rs.core.Response	validateChart(String queryString, String days, String periodName)	Ensures all parameters are valid for the Average Age Chart

Methods inherited from class com.atlassian.jira.gadgets.system.SearchQueryBackedResource

getFilterTitle, getFilterUrl, getSearchRequestAndValidate, validateSize

Methods inherited from class com.atlassian.jira.gadgets.system.AbstractResource

createErrorResponse, createIndexingUnavailableResponse, createValidationResponse

Methods inherited from class java.lang.Object

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

Constructor Details

AverageAgeChartResource

@Inject
public AverageAgeChartResource(ChartFactory chartFactory,
 ChartUtils chartUtils,
 JiraAuthenticationContext authenticationContext,
 PermissionManager permissionManager,
 SearchService searchService,
 VelocityRequestContextFactory velocityRequestContextFactory,
 ApplicationProperties applicationProperties,
 TimeZoneManager timeZoneManager)

Method Details

generateChart

@GET
@Path("/generate")
public javax.ws.rs.core.Response generateChart(@Context
 javax.servlet.http.HttpServletRequest request,
 @QueryParam("projectOrFilterId")
 String queryString,
 @QueryParam("daysprevious") @DefaultValue("30")
 String days,
 @QueryParam("periodName") @DefaultValue("daily")
 String periodName,
 @QueryParam("returnData") @DefaultValue("false")
 boolean returnData,
 @QueryParam("width") @DefaultValue("450")
 int width,
 @QueryParam("height") @DefaultValue("300")
 int height,
 @QueryParam("inline") @DefaultValue("false")
 boolean inline)

Generate an Average Age Chart and returns a simple bean containing all relievent information

Parameters:

request - The current HTTPRequest. Needed for url generation

queryString - a filter id (starts with "filter-") or project id (starts with "project-")or jql (starts with "jql-")

days - The number of days previous to go back for. Must be positive.

periodName - The name of the period. See - ChartFactory.PeriodName

returnData - whether to return the data or not

width - the width of the chart in pixels (defaults to 400px)

height - the height of the chart in pixels (defaults to 250px)

Returns:

a DateRangeChart if all params validated else a Collection of ValidationError

validateChart

@GET
@Path("/validate")
public javax.ws.rs.core.Response validateChart(@QueryParam("projectOrFilterId")
 String queryString,
 @QueryParam("daysprevious") @DefaultValue("30")
 String days,
 @QueryParam("periodName") @DefaultValue("daily")
 String periodName)

Ensures all parameters are valid for the Average Age Chart

Parameters:

queryString - a filter id (starts with "filter-") or project id (starts with "project-").

days - The number of days previous to go back for. Must be positive.

periodName - The name of the period. See - ChartFactory.PeriodName

Returns:

a Collection of ValidationError. Or empty list if no errors.