io.crnk.core.engine.query

Interface QueryAdapter

All Known Implementing Classes:

QueryParamsAdapter, QuerySpecAdapter

public interface QueryAdapter

Method Summary

Modifier and Type	Method and Description
QueryAdapter	duplicate()
TypedParams<IncludedFieldsParams>	getIncludedFields()
TypedParams<IncludedRelationsParams>	getIncludedRelations()
java.lang.Long	getLimit()
long	getOffset()
ResourceInformation	getResourceInformation()
void	setLimit(java.lang.Long limit)
void	setOffset(long offset)
QueryParams	toQueryParams() The QueryParams instance for this query adapter if possible.
QuerySpec	toQuerySpec() The QuerySpec instance for this query adapter if possible.

Method Detail

getIncludedRelations

TypedParams<IncludedRelationsParams> getIncludedRelations()

getIncludedFields

TypedParams<IncludedFieldsParams> getIncludedFields()

getResourceInformation

ResourceInformation getResourceInformation()

getLimit

java.lang.Long getLimit()

Returns:

maximum number of resources to return or null for unbounded

setLimit

void setLimit(java.lang.Long limit)

getOffset

long getOffset()

Returns:

maximum number of resources to skip in the response.

setOffset

void setOffset(long offset)

duplicate

QueryAdapter duplicate()

Returns:

duplicate of this instance

toQueryParams

QueryParams toQueryParams()

The QueryParams instance for this query adapter if possible.

Returns:

may return null if the implementation does not support QueryParams

toQuerySpec

QuerySpec toQuerySpec()

The QuerySpec instance for this query adapter if possible.

Returns:

may return null if the implementation does not support QueryParams