com.adobe.cq.commerce.api

Class CommerceQuery

java.lang.Object

com.adobe.cq.commerce.api.CommerceQuery

@ProviderType
public class CommerceQuery
extends java.lang.Object

Class that describes a commerce search query. Use the embedded CommerceQuery.Builder to create instances of this.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommerceQuery.Builder A generic builder for queries executed via CommerceService.search(CommerceQuery).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PARAM_PAGE
static java.lang.String	PARAM_PAGESIZE
static java.lang.String	PARAM_QUERYTEXT
static java.lang.String	PARAM_SORTID

Constructor Summary

Constructors

Constructor and Description
CommerceQuery(HttpServletRequest request)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getFacets() Get the list of facets applicable to current search.
int	getPage() Get the result page's index.
int	getPageSize() Get the page size.
java.lang.String	getQueryText() Get the query string.
java.lang.String	getSortId() Get the sort type's identifier.

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_QUERYTEXT

public static final java.lang.String PARAM_QUERYTEXT

See Also:

Constant Field Values

PARAM_PAGE

public static final java.lang.String PARAM_PAGE

See Also:

Constant Field Values

PARAM_PAGESIZE

public static final java.lang.String PARAM_PAGESIZE

See Also:

Constant Field Values

PARAM_SORTID

public static final java.lang.String PARAM_SORTID

See Also:

Constant Field Values

Constructor Detail

CommerceQuery

public CommerceQuery(HttpServletRequest request)

Method Detail

getQueryText

public java.lang.String getQueryText()

Get the query string.

getPage

public int getPage()

Get the result page's index.

getPageSize

public int getPageSize()

Get the page size.

getSortId

public java.lang.String getSortId()

Get the sort type's identifier.

getFacets

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFacets()

Get the list of facets applicable to current search.