BaseQuery Class
- java.
lang. Object - com.
microsoft. store. partnercenter. models. query. BaseQuery
- com.
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 Base |
| protected | BaseQuery(Object token) |
Initializes a new instance of the Base |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
Field |
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. |
|
Seek |
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. |
|
Query |
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
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:
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:
setIndex
public void setIndex(int value)
Sets the result starting index.
Parameters:
setPageSize
public void setPageSize(int value)
Sets the results page size.
Parameters:
setSeekOperation
public void setSeekOperation(SeekOperation value)
Sets the seek operation that needs to be performed.
Parameters:
setSort
public void setSort(Sort value)
Sets the query sorting options.
Parameters:
setToken
public void setToken(Object value)
Sets the query token.
Parameters: