com.adobe.cq.social.scf

Interface QueryRequestInfo

All Known Implementing Classes:

BaseQueryRequestInfo

public interface QueryRequestInfo

The QueryRequestInfo maintains information such as pagination, query predicates of a client request.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	QueryRequestInfo.QueryRequestInfoFactory

Field Summary

Fields

Modifier and Type	Field and Description
static QueryRequestInfo.QueryRequestInfoFactory	DEFAULT_QUERY_INFO_FACTORY
static java.lang.String	GET
static java.util.List<java.lang.String>	SCF_SELECTORS

Method Summary

Modifier and Type	Method and Description
CollectionPagination	getPagination() Get the request paging specification
java.util.Map<java.lang.String,java.lang.String[]>	getPredicates() Get the query predicates.
java.lang.String	getQueryString() Gets the query params.
java.util.List<java.lang.String>	getSortBy()
java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>>	getSortFields() Gets the sort fields.
CollectionSortedOrder	getSortOrder() Deprecated.
boolean	isQuery() Is the request a query request
boolean	isSortRequest() Is the request a sort request
boolean	isTranslationRequest() Is the request a translate request
void	setPagination(CollectionPagination pagination) Set the pagination
void	setSortBy(java.util.List<java.lang.String> sortBy)
void	setSortFields(java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortFields) Sets the sort fields.
void	setSortOrder(CollectionSortedOrder order) Deprecated.
void	setSortRequest(boolean isSortRequest) Sets the property that identifies if the QueryRequest is a sort request.
void	setTranslationRequest(boolean isTranslationRequest) Set the translation request

Field Detail

GET

static final java.lang.String GET

See Also:

Constant Field Values

SCF_SELECTORS

static final java.util.List<java.lang.String> SCF_SELECTORS

DEFAULT_QUERY_INFO_FACTORY

static final QueryRequestInfo.QueryRequestInfoFactory DEFAULT_QUERY_INFO_FACTORY

Method Detail

isQuery

boolean isQuery()

Is the request a query request

Returns:

boolean

isTranslationRequest

boolean isTranslationRequest()

Is the request a translate request

Returns:

boolean

isSortRequest

boolean isSortRequest()

Is the request a sort request

Returns:

boolean

setSortRequest

void setSortRequest(boolean isSortRequest)

Sets the property that identifies if the QueryRequest is a sort request.

Parameters:

isSortRequest - the new sort request

setTranslationRequest

void setTranslationRequest(boolean isTranslationRequest)

Set the translation request

Parameters:

isTranslationRequest - request value

getPredicates

java.util.Map<java.lang.String,java.lang.String[]> getPredicates()

Get the query predicates.

Returns:

null if the request is not a query request, otherwise, the method returns a map of the query predicates

getPagination

CollectionPagination getPagination()

Get the request paging specification

Returns:

CollectionPagination

setPagination

void setPagination(CollectionPagination pagination)

Set the pagination

Parameters:

pagination - the pagination setting.

setSortBy

void setSortBy(java.util.List<java.lang.String> sortBy)

Parameters:

sortBy - list of indexes to use to sort the list by

getSortBy

java.util.List<java.lang.String> getSortBy()

Returns:

List - the list of index names requested to sort the list by

getSortFields

java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> getSortFields()

Gets the sort fields. Its a ordered list. For a sort field [{"subject", true},{"added", false}] like this would sort UGC based on subject in ascending order and then by create date

Returns:

the sort fields

setSortFields

void setSortFields(java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortFields)

Sets the sort fields.

Parameters:

sortFields - the sort fields

getQueryString

java.lang.String getQueryString()

Gets the query params.

Returns:

the query params

setSortOrder

@Deprecated
void setSortOrder(CollectionSortedOrder order)

Deprecated.

Parameters:

order - for the list

getSortOrder

@Deprecated
CollectionSortedOrder getSortOrder()

Deprecated.

Returns:

the requested order to sort the list by