public class

IssueTableResource

extends AbstractResource
java.lang.Object
   ↳ com.atlassian.jira.gadgets.system.AbstractResource
     ↳ com.atlassian.jira.gadgets.system.IssueTableResource

Class Overview

REST resource to retreive a pre-rendered issue table.

Summary

Nested Classes
class IssueTableResource.IssueTable  
Constants
String PROJECT_ID
Public Constructors
IssueTableResource(JiraAuthenticationContext authenticationContext, SearchService searchService, SearchProvider searchProvider, TableLayoutUtils tableLayoutUtils, SearchRequestService searchRequestService, FieldManager fieldManager, SearchSortUtil searchSortUtil, ProjectManager projectManager, PermissionManager permissionManager, VersionManager versionManager, VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, ColumnLayoutManager columnLayoutManager, JqlStringSupport jqlStringSupport)
Public Methods
Map<String, String> generateColumnSortJql(SearchRequest sr, IssueTableResource.LinkedLabelledQuery query, List<ColumnLayoutItem> columns)
Response getFilterTable(HttpServletRequest request, String context, String filterId, List<String> columnNames, String sortBy, boolean isPaging, int start, String numberToShow, boolean enableSorting, boolean displayHeader, boolean showActions, boolean addDefaults)
Validates and then creates an issue table based off a filter
Response getIterationTable(HttpServletRequest request, String context, String projectId, boolean completed, List<String> columnNames, String sortBy, boolean isPaging, int start, String numberToShow, boolean enableSorting, boolean displayHeader, boolean showActions)
Validates and then creates an issue table based the next unreleased version for a project
Response getJqlTable(HttpServletRequest request, String context, String jql, String title, List<String> columnNames, String sortBy, boolean isPaging, int start, String numberToShow, boolean enableSorting, boolean displayHeader, boolean showActions, boolean addDefaults, boolean useConfiguredCols)
Response validateFilterTable(String filterId, List<String> columnNames, String numberToShow)
Validates the input for an issue table based off a filter
Response validateIterationTable(String projectId, List<String> columnNames, String numberToShow)
Validates the input for an issue table based the next unreleased version for a project
Response validateJql(String numberToShow, List<String> columnNames)
[Expand]
Inherited Methods
From class com.atlassian.jira.gadgets.system.AbstractResource
From class java.lang.Object

Constants

protected static final String PROJECT_ID

Constant Value: "projectId"

Public Constructors

public IssueTableResource (JiraAuthenticationContext authenticationContext, SearchService searchService, SearchProvider searchProvider, TableLayoutUtils tableLayoutUtils, SearchRequestService searchRequestService, FieldManager fieldManager, SearchSortUtil searchSortUtil, ProjectManager projectManager, PermissionManager permissionManager, VersionManager versionManager, VelocityRequestContextFactory velocityRequestContextFactory, ApplicationProperties applicationProperties, ColumnLayoutManager columnLayoutManager, JqlStringSupport jqlStringSupport)

Public Methods

public Map<String, String> generateColumnSortJql (SearchRequest sr, IssueTableResource.LinkedLabelledQuery query, List<ColumnLayoutItem> columns)

public Response getFilterTable (HttpServletRequest request, String context, String filterId, List<String> columnNames, String sortBy, boolean isPaging, int start, String numberToShow, boolean enableSorting, boolean displayHeader, boolean showActions, boolean addDefaults)

Validates and then creates an issue table based off a filter

Parameters
request the current request.
context the context which the table is being rendered. Used for getting default columns, and redirects
filterId the filter id of the filter to create the table for
columnNames the column names to display (this can be left blank to get the default columns)
sortBy The extra column to sort by with optional :ASC or :DESC suffix
isPaging Is paging enabled
start The issue to start from
numberToShow the number of issues to display per page
enableSorting enable sorting
displayHeader display the header?
showActions show the actions column
addDefaults add the default columns to the table
Returns

public Response getIterationTable (HttpServletRequest request, String context, String projectId, boolean completed, List<String> columnNames, String sortBy, boolean isPaging, int start, String numberToShow, boolean enableSorting, boolean displayHeader, boolean showActions)

Validates and then creates an issue table based the next unreleased version for a project

Parameters
request the current request.
context the context which the table is being rendered. Used for getting default columns, and redirects
projectId the project to get the next unreleased version for and base the table off
completed Whether to show completed or uncompleted issues
columnNames the column names to display (this can be left blank to get the default columns)
sortBy The extra column to sort by with optional :ASC or :DESC suffix
isPaging Is paging enabled
start The issue to start from
numberToShow the number of issues to display per page
enableSorting enable sorting
displayHeader display the header?
showActions show the actions column
Returns

public Response getJqlTable (HttpServletRequest request, String context, String jql, String title, List<String> columnNames, String sortBy, boolean isPaging, int start, String numberToShow, boolean enableSorting, boolean displayHeader, boolean showActions, boolean addDefaults, boolean useConfiguredCols)

public Response validateFilterTable (String filterId, List<String> columnNames, String numberToShow)

Validates the input for an issue table based off a filter

Parameters
filterId the filter id of the filter to create the table for
columnNames the column names to display (this can be left blank to get the default columns)
numberToShow the number of issues to display per page
Returns
  • A response containing and empty 200 response or a 400 containg a ErrorCollection containg all validation errors

public Response validateIterationTable (String projectId, List<String> columnNames, String numberToShow)

Validates the input for an issue table based the next unreleased version for a project

Parameters
projectId the project to get the next unreleased version for and base the table off
columnNames the column names to display (this can be left blank to get the default columns)
numberToShow the number of issues to display per page
Returns
  • A response containing and empty 200 response or a 400 containg a ErrorCollection containg all validation errors

public Response validateJql (String numberToShow, List<String> columnNames)