com.atlassian.jira.gadgets.system
Class CreatedVsResolvedResource

java.lang.Object
  com.atlassian.jira.gadgets.system.AbstractResource
      com.atlassian.jira.gadgets.system.SearchQueryBackedResource
          com.atlassian.jira.gadgets.system.CreatedVsResolvedResource

public class CreatedVsResolvedResource
extends SearchQueryBackedResource

REST endpoint to validate and retreive a Created vs Resolved chart.

Since:

v4.0

Nested Class Summary

static class	CreatedVsResolvedResource.CreatedVsResolvedChart A simple bean contain all information required to render the Created Versus Chart
static class	CreatedVsResolvedResource.DataRow

Field Summary

static String	DAYS_NAME
static String	VERSION_LABEL

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

authenticationContext, chartUtils, permissionManager, QUERY_STRING, searchService

Constructor Summary

CreatedVsResolvedResource(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, String versionLabel, boolean isCumulative, boolean showUnresolvedTrend, boolean returnData, int width, int height) Generate a create Versus Resolved Chart and returns a simple bean containing all relievent information
javax.ws.rs.core.Response	validateChart(String queryString, String days, String periodName, String versionLabel) Ensures all parameters are valid for the Created Versus Resolved 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

Field Detail

DAYS_NAME

public static final String DAYS_NAME

See Also:

Constant Field Values

VERSION_LABEL

public static final String VERSION_LABEL

See Also:

Constant Field Values

Constructor Detail

CreatedVsResolvedResource

public CreatedVsResolvedResource(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,
                                               String versionLabel,
                                               boolean isCumulative,
                                               boolean showUnresolvedTrend,
                                               boolean returnData,
                                               int width,
                                               int height)

Generate a create Versus Resolved 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

versionLabel - The name of teh versions to show. See - ChartFactory.VersionLabel

isCumulative - Whether or not the values are added to the previous value.

showUnresolvedTrend - Show sub-chart underneath showing trend of unresolved issues

returnData - Whether or not to have data returned

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

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

Returns:

a CreatedVsResolvedResource.CreatedVsResolvedChart if all params validated else a Collection of ValidationError

validateChart

public javax.ws.rs.core.Response validateChart(String queryString,
                                               String days,
                                               String periodName,
                                               String versionLabel)

Ensures all parameters are valid for the Created Versus Resolved 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

versionLabel - The name of teh versions to show. See - ChartFactory.VersionLabel

Returns:

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