com.adobe.cq.commerce.api

Class CommerceQuery.Builder

java.lang.Object

com.adobe.cq.commerce.api.CommerceQuery.Builder

Enclosing class:

CommerceQuery

public static class CommerceQuery.Builder
extends java.lang.Object

A generic builder for queries executed via CommerceService.search(CommerceQuery).

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CommerceQuery	build() Build a query from this builder
CommerceQuery.Builder	setPage(int page) Set the current page within the search results page set.
CommerceQuery.Builder	setPageSize(int pageSize) Set the number of hits to display per page of the search results.
CommerceQuery.Builder	setQueryText(java.lang.String queryText) Set the actual query string.
void	setSortId(java.lang.String sortId) Set the sort type's identifier.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setQueryText

public CommerceQuery.Builder setQueryText(java.lang.String queryText)

Set the actual query string. Allowed query terms depend on the commerce provider.

setPage

public CommerceQuery.Builder setPage(int page)

Set the current page within the search results page set.

setPageSize

public CommerceQuery.Builder setPageSize(int pageSize)

Set the number of hits to display per page of the search results.

setSortId

public void setSortId(java.lang.String sortId)

Set the sort type's identifier. Allowed sort types are depend on the commerce provider and should generally be set to one of the values returned from CommerceResult.getSorts().

build

public CommerceQuery build()
                    throws java.lang.IllegalStateException

Build a query from this builder

Throws:

java.lang.IllegalStateException - if no queryText has been set