com.elasticpath.domain.catalogview
Interface CatalogViewResult

All Superinterfaces:

EpDomain, java.io.Serializable, Transient

All Known Subinterfaces:

BrowsingResult, SearchResult

All Known Implementing Classes:

AbstractCatalogViewResultImpl, BrowsingResultImpl, SearchResultImpl

public interface CatalogViewResult
extends Transient

Represents a catalog view result.

Method Summary

java.util.List	getBrandFilterOptions() Returns a list of filter options on brand.
CatalogViewRequest	getCatalogViewRequest() Returns the catalog view request which generated this search result.
Category	getCategory() Returns the category.
java.util.List	getFeaturedProducts() Returns a list of featured products.
java.util.List	getPriceFilterOptions() Returns a list of filter options on price range.
java.util.List	getProducts() Returns a list of products as the search result.
java.util.List	getSortedProducts() Returns a list of products as the search result.
void	replicateData(CatalogViewResult catalogViewResult) Replicate the data to this CatalogViewResult from the given CatalogViewResult.
void	setCatalogViewRequest(CatalogViewRequest catalogViewRequest) Sets the catalog view request which generated this search result.
void	setCategory(Category category) Sets the category.
void	setFeaturedProducts(java.util.List featuredProducts) Sets a list of featured products.
void	setProducts(java.util.List products) Sets a list of products as the search result.

Methods inherited from interface com.elasticpath.domain.EpDomain

getElasticPath, setElasticPath

Method Detail

getBrandFilterOptions

java.util.List getBrandFilterOptions()

Returns a list of filter options on brand.

Returns:

a list of filter options on brand.

getCatalogViewRequest

CatalogViewRequest getCatalogViewRequest()

Returns the catalog view request which generated this search result.

Returns:

the catalog view request

getCategory

Category getCategory()

Returns the category.

Returns:

the category.

getFeaturedProducts

java.util.List getFeaturedProducts()

Returns a list of featured products.

Returns:

a list of featured products

getPriceFilterOptions

java.util.List getPriceFilterOptions()

Returns a list of filter options on price range.

Returns:

a list of filter options on price range.

getProducts

java.util.List getProducts()

Returns a list of products as the search result. The list has been sorted based on the sorter specified in CatalogViewRequest.

Returns:

a list of products as the search result.

getSortedProducts

java.util.List getSortedProducts()

Returns a list of products as the search result. This list has been sorted based on the sorter specified in CatalogViewRequest.

Returns:

a list of products as the search result.

replicateData

void replicateData(CatalogViewResult catalogViewResult)

Replicate the data to this CatalogViewResult from the given CatalogViewResult.

Parameters:

catalogViewResult - the CatalogViewResult to be replicated

setCatalogViewRequest

void setCatalogViewRequest(CatalogViewRequest catalogViewRequest)

Sets the catalog view request which generated this search result.

Parameters:

catalogViewRequest - the catalog view request

setCategory

void setCategory(Category category)

Sets the category.

Parameters:

category - the category to set

setFeaturedProducts

void setFeaturedProducts(java.util.List featuredProducts)

Sets a list of featured products.

Parameters:

featuredProducts - a list of featured products

setProducts

void setProducts(java.util.List products)

Sets a list of products as the search result.

Parameters:

products - a list of products as the search result.