Package com.broadleafcommerce.catalogbrowse.domain

Class BrowseEntityDetails

java.lang.Object

com.broadleafcommerce.catalogbrowse.domain.BrowseEntityDetails

All Implemented Interfaces:

Serializable

public class BrowseEntityDetails
extends Object
implements Serializable

A structure containing either a Product or a Category for a BrowseDetailsRequest.

Note: In the case of a category matching the URIs requested, only one category may be returned.

Author:

Nathan Moore (nathandmoore)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BrowseEntityDetails()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Category	getCategory()	The category that matched the BrowseDetailsRequest.
List<ContentItem>	getContentItems()	The ContentItems that matched the BrowseDetailsRequest if not paginated.
Set<String>	getItemIdsNotFound()	Any requested ContentItem ids that did not match active content.
Set<String>	getItemNamesNotFound()	Any requested ContentItem names that did not match active content.
SimplePage<ContentItem>	getPaginatedContentItems()	The ContentItems that matched the BrowseDetailsRequest if paginated.
List<Product>	getProducts()	All Products and their details if products match the BrowseDetailsRequest.
Set<String>	getUrisForMissingEntities()	All URIs that failed to match known Products or Categories.
int	hashCode()
boolean	hasResults()
void	setCategory(Category category)	The category that matched the BrowseDetailsRequest.
void	setContentItems(List<ContentItem> contentItems)	The ContentItems that matched the BrowseDetailsRequest if not paginated.
void	setItemIdsNotFound(Set<String> itemIdsNotFound)	Any requested ContentItem ids that did not match active content.
void	setItemNamesNotFound(Set<String> itemNamesNotFound)	Any requested ContentItem names that did not match active content.
void	setPaginatedContentItems(SimplePage<ContentItem> paginatedContentItems)	The ContentItems that matched the BrowseDetailsRequest if paginated.
void	setProducts(List<Product> products)	All Products and their details if products match the BrowseDetailsRequest.
void	setUrisForMissingEntities(Set<String> urisForMissingEntities)	All URIs that failed to match known Products or Categories.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BrowseEntityDetails

public BrowseEntityDetails()

Method Details

hasResults

public boolean hasResults()

getProducts

public List<Product> getProducts()

All Products and their details if products match the BrowseDetailsRequest.

Returns:

All Products for the request.

getCategory

public Category getCategory()

The category that matched the BrowseDetailsRequest.

Returns:

The category that matched the BrowseDetailsRequest.

getContentItems

public List<ContentItem> getContentItems()

The ContentItems that matched the BrowseDetailsRequest if not paginated.

Returns:

The ContentItems that matched the BrowseDetailsRequest.

getPaginatedContentItems

public SimplePage<ContentItem> getPaginatedContentItems()

The ContentItems that matched the BrowseDetailsRequest if paginated.

Returns:

The ContentItems that matched the BrowseDetailsRequest.

getUrisForMissingEntities

public Set<String> getUrisForMissingEntities()

All URIs that failed to match known Products or Categories.

Returns:

All URIs that failed to match known Products or Categories.

getItemNamesNotFound

@NonNull
public Set<String> getItemNamesNotFound()

Any requested ContentItem names that did not match active content.

Returns:

Any requested ContentItem names that did not match active content.

getItemIdsNotFound

@NonNull
public Set<String> getItemIdsNotFound()

Any requested ContentItem ids that did not match active content.

Returns:

Any requested ContentItem ids that did not match active content.

setProducts

public void setProducts(List<Product> products)

All Products and their details if products match the BrowseDetailsRequest.

Parameters:

products - All Products for the request.

setCategory

public void setCategory(Category category)

The category that matched the BrowseDetailsRequest.

Parameters:

category - The category that matched the BrowseDetailsRequest.

setContentItems

public void setContentItems(List<ContentItem> contentItems)

The ContentItems that matched the BrowseDetailsRequest if not paginated.

Parameters:

contentItems - The ContentItems that matched the BrowseDetailsRequest.

setPaginatedContentItems

public void setPaginatedContentItems(SimplePage<ContentItem> paginatedContentItems)

The ContentItems that matched the BrowseDetailsRequest if paginated.

Parameters:

contentItems - The ContentItems that matched the BrowseDetailsRequest.

setUrisForMissingEntities

public void setUrisForMissingEntities(Set<String> urisForMissingEntities)

All URIs that failed to match known Products or Categories.

Parameters:

productUrisForMissingEntities - All URIs that failed to match known Products or Categories.

setItemNamesNotFound

public void setItemNamesNotFound(@NonNull
 Set<String> itemNamesNotFound)

Any requested ContentItem names that did not match active content.

setItemIdsNotFound

public void setItemIdsNotFound(@NonNull
 Set<String> itemIdsNotFound)

Any requested ContentItem ids that did not match active content.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object