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

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.util.List<java.lang.String>	getSortBy()
CollectionSortedOrder	getSortOrder()
boolean	isQuery() Is the request a query 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	setSortOrder(CollectionSortedOrder order)
void	setTranslationRequest(boolean isTranslationRequest) Set the translation request

Field Detail

DEFAULT_QUERY_INFO_FACTORY

static final QueryRequestInfo.QueryRequestInfoFactory DEFAULT_QUERY_INFO_FACTORY

Method Detail

isQuery

boolean isQuery()

Is the request a query request

isTranslationRequest

boolean isTranslationRequest()

Is the request a translate request

setTranslationRequest

void setTranslationRequest(boolean isTranslationRequest)

Set the translation request

Parameters:

translation - 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

setPagination

void setPagination(CollectionPagination pagination)

Set the pagination

Parameters:

pagination - the pagination setting.

setSortBy

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

Parameters:

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

getSortBy

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

Returns:

the list of index names requested to sort the list by

setSortOrder

void setSortOrder(CollectionSortedOrder order)

Parameters:

order - for the list

getSortOrder

CollectionSortedOrder getSortOrder()

Returns:

the requested order to sort the list by