IQuery Interface

Package:

com.microsoft.store.partnercenter.models.query

Maven Artifact:

com.microsoft.store:partnercenter:1.15.3

public interface IQuery

Represents a query on an entity. All different queries should implement this contract.

Method Summary

Modifier and Type	Method and Description
abstract FieldFilter	getFilter() Gets the query filter.
abstract int	getIndex() Gets the result starting index.
abstract int	getPageSize() Gets the results page size.
abstract SeekOperation	getSeekOperation() Gets or sets the seek operation that needs to be performed.
abstract Sort	getSort() Gets the query sorting options.
abstract java.lang.Object	getToken() Gets the query token.
abstract QueryType	getType() Gets the query type.
abstract void	setFilter(FieldFilter value) The query filter.
abstract void	setIndex(int value) Sets the result starting index.
abstract void	setPageSize(int value) Sets the results page size.
abstract void	setSeekOperation(SeekOperation value) Sets the seek operation that needs to be performed.
abstract void	setSort(Sort value) Sets the query sorting options.
abstract void	setToken(Object value) Sets the query token.

Method Details

getFilter

public abstract FieldFilter getFilter()

Gets the query filter.

Returns:

The query filter.

getIndex

public abstract int getIndex()

Gets the result starting index.

Returns:

The result starting index.

getPageSize

public abstract int getPageSize()

Gets the results page size.

Returns:

The result page size.

getSeekOperation

public abstract SeekOperation getSeekOperation()

Gets or sets the seek operation that needs to be performed.

Returns:

The seek operation that needs to be performed.

getSort

public abstract Sort getSort()

Gets the query sorting options.

Returns:

The query sorting options.

getToken

public abstract Object getToken()

Gets the query token. The token may hold context used to represent current state with back end services.

Returns:

The query token.

getType

public abstract QueryType getType()

Gets the query type.

Returns:

The query type.

setFilter

public abstract void setFilter(FieldFilter value)

The query filter.

Parameters:

value - The query filter.

setIndex

public abstract void setIndex(int value)

Sets the result starting index.

Parameters:

value - The result starting index.

setPageSize

public abstract void setPageSize(int value)

Sets the results page size.

Parameters:

value - The results page size.

setSeekOperation

public abstract void setSeekOperation(SeekOperation value)

Sets the seek operation that needs to be performed.

Parameters:

value - The seek operation that needs to be performed.

setSort

public abstract void setSort(Sort value)

Sets the query sorting options.

Parameters:

value - The query sorting options.

setToken

public abstract void setToken(Object value)

Sets the query token.

Parameters:

value - The query token.