com.adobe.cq.commerce.common

Interface CommerceSearchProvider

@ConsumerType
public interface CommerceSearchProvider

The CommerceSearchProvider is the common interface of search providers for the e-commerce system. A search provider implements the backend of the search system and can be plugged into the e-commerce system to provide search functionality tailored to the special needs of a certain application domain.

See Also:

AbstractJcrCommerceService.getSearchProvider()

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME_PROPERTY Property name for the 'name' property of a CommerceSearchProvider service.

Method Summary

Modifier and Type	Method and Description
CommerceResult	search(CommerceQuery query, CommerceService service) Perform a search.

Field Detail

NAME_PROPERTY

static final java.lang.String NAME_PROPERTY

Property name for the 'name' property of a CommerceSearchProvider service.

See Also:

Constant Field Values

Method Detail

search

CommerceResult search(CommerceQuery query,
                      CommerceService service)
               throws CommerceException

Perform a search.

Parameters:

query - the search query as a CommerceQuery

service - the commerce service requesting the search

Returns:

a the search results as a CommerceResult

Throws:

CommerceException - if an error occurs during the search process.