Package com.atlassian.jira.components.orderby.rest

Class OrderByOptionsResource

java.lang.Object

com.atlassian.jira.components.orderby.rest.OrderByOptionsResource

@Path("orderByOptions")
@Consumes("application/json")
@Produces("application/json")
public class OrderByOptionsResource
extends Object

Returns the fields that users can sort by along with the corresponding sort JQL.

Since:

v2.0.12

Constructor Summary

Constructors

Constructor	Description
OrderByOptionsResource(FieldManager fieldManager, JqlQueryParser jqlQueryParser, SortJqlGenerator sortJqlGenerator, JiraAuthenticationContext jiraAuthenticationContext, FilterLookerUpper filterLookerUpper, OrderByUtil orderByUtil)	Creates a new OrderByOptionsResource.

Method Summary

Modifier and Type	Method	Description
OrderByOptions	getOrderByOptions(OrderByRequest request)	Returns the order-by options that are available that match fieldNamePrefix.
SortByBean	getPrimary(OrderByRequest request)	Returns the order-by options that are available that match fieldNamePrefix.

Methods inherited from class java.lang.Object

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

Constructor Details

OrderByOptionsResource

@Inject
public OrderByOptionsResource(FieldManager fieldManager,
 JqlQueryParser jqlQueryParser,
 SortJqlGenerator sortJqlGenerator,
 JiraAuthenticationContext jiraAuthenticationContext,
 FilterLookerUpper filterLookerUpper,
 OrderByUtil orderByUtil)

Creates a new OrderByOptionsResource.

Method Details

getOrderByOptions

@POST
public OrderByOptions getOrderByOptions(OrderByRequest request)

Returns the order-by options that are available that match fieldNamePrefix. If fieldNamePrefix is null or a blank String then this method returns the first maxResults options (defaults to 10 and is hard-limited to 50).

Parameters:

request - the body of the request.

Returns:

OrderByOptions

getPrimary

@POST
@Path("primary")
public SortByBean getPrimary(OrderByRequest request)

Returns the order-by options that are available that match fieldNamePrefix. If fieldNamePrefix is null or a blank String then this method returns the first maxResults options (defaults to 10 and is hard-limited to 50).

Parameters:

request - the body of the request.

Returns:

OrderByOptions