com.atlassian.jira.gadgets.system
Class AverageAgeChartResource

java.lang.Object
  extended by com.atlassian.jira.gadgets.system.AbstractResource
      extended by com.atlassian.jira.gadgets.system.SearchQueryBackedResource
          extended by com.atlassian.jira.gadgets.system.AverageAgeChartResource

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
AverageAgeChartResource(ChartFactory chartFactory, ChartUtils chartUtils, JiraAuthenticationContext authenticationContext, PermissionManager permissionManager, SearchService searchService, VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, TimeZoneManager timeZoneManager)
           
 
Method Summary
 javax.ws.rs.core.Response generateChart(javax.servlet.http.HttpServletRequest request, String queryString, String days, String periodName, boolean returnData, int width, int height)
          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
 
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 Detail

AverageAgeChartResource

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

generateChart

public javax.ws.rs.core.Response generateChart(@Context
                                               javax.servlet.http.HttpServletRequest request,
                                               String queryString,
                                               String days,
                                               String periodName,
                                               boolean returnData,
                                               int width,
                                               int height)
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

public javax.ws.rs.core.Response validateChart(String queryString,
                                               String days,
                                               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.


Copyright © 2002-2013 Atlassian. All Rights Reserved.