Package 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

@Path("/createdVsResolved")
@Produces("application/json")
public class CreatedVsResolvedResource
extends SearchQueryBackedResource

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

Since:

v4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreatedVsResolvedResource.CreatedVsResolvedChart	A simple bean contain all information required to render the Created Versus Chart
static class	CreatedVsResolvedResource.DataRow

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DAYS_NAME
static final String	VERSION_LABEL

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

authenticationContext, QUERY_STRING, searchService

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	generateChart(jakarta.servlet.http.HttpServletRequest request, String queryString, String days, String endDate, String periodName, String versionLabel, boolean isCumulative, boolean showUnresolvedTrend, boolean returnData, int width, int height, boolean inline)	Generate a create Versus Resolved Chart and returns a simple bean containing all relievent information
jakarta.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, validateSize

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

createErrorResponse, createIndexingUnavailableResponse, createServerErroreResponse, createValidationResponse

Methods inherited from class java.lang.Object

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

Field Details

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 Details

CreatedVsResolvedResource

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

Method Details

generateChart

@GET
@Path("/generate")
public jakarta.ws.rs.core.Response generateChart(@Context
 jakarta.servlet.http.HttpServletRequest request,
 @QueryParam("projectOrFilterId")
 String queryString,
 @QueryParam("daysprevious") @DefaultValue("30")
 String days,
 @QueryParam("endDate")
 String endDate,
 @QueryParam("periodName") @DefaultValue("daily")
 String periodName,
 @QueryParam("versionLabel") @DefaultValue("major")
 String versionLabel,
 @QueryParam("isCumulative") @DefaultValue("true")
 boolean isCumulative,
 @QueryParam("showUnresolvedTrend") @DefaultValue("false")
 boolean showUnresolvedTrend,
 @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 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

@GET
@Path("/validate")
public jakarta.ws.rs.core.Response validateChart(@QueryParam("projectOrFilterId")
 String queryString,
 @QueryParam("daysprevious") @DefaultValue("30")
 String days,
 @QueryParam("periodName") @DefaultValue("daily")
 String periodName,
 @QueryParam("versionLabel") @DefaultValue("major")
 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.