BaseQuery Class

  • java.lang.Object
    • com.microsoft.store.partnercenter.models.query.BaseQuery

Implements

public abstract class BaseQuery implements IQuery

The base class which all queries should derive from. This class does not support any query capabilities except for the token by default. Therefore, implementation classes will pick and choose what to support.

Constructor Summary

Modifier Constructor Description
protected BaseQuery()

Initializes a new instance of the BaseQuery class.

protected BaseQuery(Object token)

Initializes a new instance of the BaseQuery class.

Method Summary

Modifier and Type Method and Description
FieldFilter getFilter()

Gets or sets the query filter.

int getIndex()

Gets or sets the result starting index.

int getPageSize()

Gets or sets the results page size.

SeekOperation getSeekOperation()

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

Sort getSort()

Gets or sets the query sorting options.

java.lang.Object getToken()

Gets the query token.

QueryType getType()

Gets the query type.

void setFilter(FieldFilter value)

The query filter.

void setIndex(int value)

Sets the result starting index.

void setPageSize(int value)

Sets the results page size.

void setSeekOperation(SeekOperation value)

Sets the seek operation that needs to be performed.

void setSort(Sort value)

Sets the query sorting options.

void setToken(Object value)

Sets the query token.

Inherited Members

java.lang.Object.clone() java.lang.Object.equals(java.lang.Object) java.lang.Object.finalize() java.lang.Object.getClass() java.lang.Object.hashCode() java.lang.Object.notify() java.lang.Object.notifyAll() java.lang.Object.toString() java.lang.Object.wait() java.lang.Object.wait(long) java.lang.Object.wait(long,int)

Constructor Details

BaseQuery

protected BaseQuery()

Initializes a new instance of the BaseQuery class.

BaseQuery

protected BaseQuery(Object token)

Initializes a new instance of the BaseQuery class.

Parameters:

token - The query token.

Method Details

getFilter

public FieldFilter getFilter()

Gets or sets the query filter.

getIndex

public int getIndex()

Gets or sets the result starting index.

getPageSize

public int getPageSize()

Gets or sets the results page size.

getSeekOperation

public SeekOperation getSeekOperation()

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

getSort

public Sort getSort()

Gets or sets the query sorting options.

getToken

public Object getToken()

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

getType

public QueryType getType()

Gets the query type.

setFilter

public void setFilter(FieldFilter value)

The query filter.

Parameters:

value

setIndex

public void setIndex(int value)

Sets the result starting index.

Parameters:

value

setPageSize

public void setPageSize(int value)

Sets the results page size.

Parameters:

value

setSeekOperation

public void setSeekOperation(SeekOperation value)

Sets the seek operation that needs to be performed.

Parameters:

value

setSort

public void setSort(Sort value)

Sets the query sorting options.

Parameters:

value

setToken

public void setToken(Object value)

Sets the query token.

Parameters:

value

Applies to