QueryFactory Class

Package:

com.microsoft.store.partnercenter.models.query

Maven Artifact:

com.microsoft.store:partnercenter:1.15.3

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

public class QueryFactory

Creates new instances of IQuery objects.

Method Summary

Modifier and Type	Method and Description
IQuery	buildCountQuery() Builds a count query.
IQuery	buildCountQuery(FieldFilter filter) Builds a count query.
IQuery	buildCountQuery(FieldFilter filter, Object token) Builds a count query.
IQuery	buildIndexedQuery(int pageSize) Builds an indexed query.
IQuery	buildIndexedQuery(int pageSize, int index) Builds an indexed query.
IQuery	buildIndexedQuery(int pageSize, int index, FieldFilter filter) Builds an indexed query.
IQuery	buildIndexedQuery(int pageSize, int index, FieldFilter filter, Sort sortOption) Builds an indexed query.
IQuery	buildIndexedQuery(int pageSize, int index, FieldFilter filter, Sort sortOption, Object token) Builds an indexed query.
IQuery	buildSeekQuery(SeekOperation seekOperation) Builds a seek query.
IQuery	buildSeekQuery(SeekOperation seekOperation, int pageSize) Builds a seek query.
IQuery	buildSeekQuery(SeekOperation seekOperation, int pageSize, int index) Builds a seek query.
IQuery	buildSeekQuery(SeekOperation seekOperation, int pageSize, int index, FieldFilter filter) Builds a seek query.
IQuery	buildSeekQuery(SeekOperation seekOperation, int pageSize, int index, FieldFilter filter, Sort sortingOption) Builds a seek query.
IQuery	buildSeekQuery(SeekOperation seekOperation, int pageSize, int index, FieldFilter filter, Sort sortingOption, Object token) Builds a seek query.
IQuery	buildSimpleQuery() Builds a simple query.
IQuery	buildSimpleQuery(FieldFilter filter) Builds a simple query.
IQuery	buildSimpleQuery(FieldFilter filter, Sort sortOption) Builds a simple query.
IQuery	buildSimpleQuery(FieldFilter filter, Sort sortOption, Object token) Builds a simple query.
static QueryFactory	getInstance() Gets an instance of the query factory.

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)

Method Details

buildCountQuery

public IQuery buildCountQuery()

Builds a count query.

Returns:

A count query.

buildCountQuery

public IQuery buildCountQuery(FieldFilter filter)

Builds a count query.

Parameters:

filter - An optional filter.

Returns:

A count query.

buildCountQuery

public IQuery buildCountQuery(FieldFilter filter, Object token)

Builds a count query.

Parameters:

filter - An optional filter.

token - Optional query token.

Returns:

A count query.

buildIndexedQuery

public IQuery buildIndexedQuery(int pageSize)

Builds an indexed query.

Parameters:

pageSize - The number of results to return.

Returns:

A paged query.

buildIndexedQuery

public IQuery buildIndexedQuery(int pageSize, int index)

Builds an indexed query.

Parameters:

pageSize - The number of results to return.

index - The results starting index.

Returns:

A paged query.

buildIndexedQuery

public IQuery buildIndexedQuery(int pageSize, int index, FieldFilter filter)

Builds an indexed query.

Parameters:

pageSize - The number of results to return.

index - The results starting index.

filter - An optional filter.

Returns:

A paged query.

buildIndexedQuery

public IQuery buildIndexedQuery(int pageSize, int index, FieldFilter filter, Sort sortOption)

Builds an indexed query.

Parameters:

pageSize - The number of results to return.

index - The results starting index.

filter - An optional filter.

sortOption - An optional sorting options.

Returns:

A paged query.

buildIndexedQuery

public IQuery buildIndexedQuery(int pageSize, int index, FieldFilter filter, Sort sortOption, Object token)

Builds an indexed query.

Parameters:

pageSize - The number of results to return.

index - The results starting index.

filter - An optional filter.

sortOption - An optional sorting options.

token - An optional query token.

Returns:

A paged query.

buildSeekQuery

public IQuery buildSeekQuery(SeekOperation seekOperation)

Builds a seek query.

Parameters:

seekOperation - The seek operation to perform.

Returns:

The seek query.

buildSeekQuery

public IQuery buildSeekQuery(SeekOperation seekOperation, int pageSize)

Builds a seek query.

Parameters:

seekOperation - The seek operation to perform.

pageSize - The desired result page size.

Returns:

The seek query.

buildSeekQuery

public IQuery buildSeekQuery(SeekOperation seekOperation, int pageSize, int index)

Builds a seek query.

Parameters:

seekOperation - The seek operation to perform.

pageSize - The desired result page size.

index - The index of the page to retrieve. This is only used if the seek operation specified a page index.

Returns:

The seek query.

buildSeekQuery

public IQuery buildSeekQuery(SeekOperation seekOperation, int pageSize, int index, FieldFilter filter)

Builds a seek query.

Parameters:

seekOperation - The seek operation to perform.

pageSize - The desired result page size.

index - The index of the page to retrieve. This is only used if the seek operation specified a page index.

filter - An optional filter to apply.

Returns:

The seek query.

buildSeekQuery

public IQuery buildSeekQuery(SeekOperation seekOperation, int pageSize, int index, FieldFilter filter, Sort sortingOption)

Builds a seek query.

Parameters:

seekOperation - The seek operation to perform.

pageSize - The desired result page size.

index - The index of the page to retrieve. This is only used if the seek operation specified a page index.

filter - An optional filter to apply.

sortingOption - An optional sorting options.

Returns:

The seek query.

buildSeekQuery

public IQuery buildSeekQuery(SeekOperation seekOperation, int pageSize, int index, FieldFilter filter, Sort sortingOption, Object token)

Builds a seek query.

Parameters:

seekOperation - The seek operation to perform.

pageSize - The desired result page size.

index - The index of the page to retrieve. This is only used if the seek operation specified a page index.

filter - An optional filter to apply.

sortingOption - An optional sorting options.

token - An optional query token.

Returns:

The seek query.

buildSimpleQuery

public IQuery buildSimpleQuery()

Builds a simple query.

Returns:

A simple query.

buildSimpleQuery

public IQuery buildSimpleQuery(FieldFilter filter)

Builds a simple query.

Parameters:

filter - An optional filter.

Returns:

A simple query.

buildSimpleQuery

public IQuery buildSimpleQuery(FieldFilter filter, Sort sortOption)

Builds a simple query.

Parameters:

filter - An optional filter.

sortOption - Optional sorting options.

Returns:

A simple query.

buildSimpleQuery

public IQuery buildSimpleQuery(FieldFilter filter, Sort sortOption, Object token)

Builds a simple query.

Parameters:

filter - An optional filter.

sortOption - Optional sorting options.

token - Optional query token.

Returns:

A simple query.

getInstance

public static QueryFactory getInstance()

Gets an instance of the query factory.

Returns:

An instance of the query factory.