com.atlassian.jira.gadgets.system
Class RecentlyCreatedChartResource

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.RecentlyCreatedChartResource

public class RecentlyCreatedChartResource
extends SearchQueryBackedResource

REST endpoint to validate and retreive a Recent Created chart.

Since:
v4.0

Nested Class Summary
static class RecentlyCreatedChartResource.DataRow
           
static class RecentlyCreatedChartResource.RecentlyCreatedChart
          A simple bean contain all information required to render the Recently Created Chart
 
Field Summary
 
Fields inherited from class com.atlassian.jira.gadgets.system.SearchQueryBackedResource
authenticationContext, chartUtils, permissionManager, QUERY_STRING, searchService
 
Constructor Summary
RecentlyCreatedChartResource(ChartUtils chartUtils, JiraAuthenticationContext authenticationContext, SearchService searchService, PermissionManager permissionManager, ChartFactory chartFactory, VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties)
           
 
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 a Recently Created Chart and returns a simple bean containing all relevent information
 javax.ws.rs.core.Response validateChart(String queryString, String days, String periodName)
          Ensures all parameters are valid for the Recently Created 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

RecentlyCreatedChartResource

public RecentlyCreatedChartResource(ChartUtils chartUtils,
                                    JiraAuthenticationContext authenticationContext,
                                    SearchService searchService,
                                    PermissionManager permissionManager,
                                    ChartFactory chartFactory,
                                    VelocityRequestContextFactory velocityRequestContextFactory,
                                    ApplicationProperties applicationProperties)
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 a Recently Created Chart and returns a simple bean containing all relevent 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
width - the width of the chart in pixels (defaults to 400px)
height - the height of the chart in pixels (defaults to 250px)
Returns:
a RecentlyCreatedChartResource.RecentlyCreatedChart 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 Recently Created 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-2014 Atlassian. All Rights Reserved.