Package com.broadleafcommerce.catalog.domain.commerce

Class BrowseDetailsRequest

java.lang.Object

com.broadleafcommerce.catalog.domain.commerce.BrowseDetailsRequest

All Implemented Interfaces:

Serializable

public class BrowseDetailsRequest
extends Object
implements Serializable

A structure representing a request for a commerce-facing browse page including identifying information for some browse entity such as a Product or Category for which to get details and interesting context information. In such a case, the caller does not know whether the information it has belongs to a Product or Category and the backend should dynamically determine that and return the corresponding entity.

Author:

Nathan Moore (nathandmoore)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BrowseDetailsRequest()
BrowseDetailsRequest(Set<String> uris, org.springframework.data.domain.Pageable productPageInfo, org.springframework.util.MultiValueMap<String,String> attributes)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
org.springframework.util.MultiValueMap<String,String>	getAttributes()	Map holding any additional attributes passed in the request not matching any defined properties.
org.springframework.data.domain.Pageable	getProductPageInfo()	Pagination info to apply to the products included in the response if this is a request matching a Category.
Set<String>	getUris()	One or more URIs identifying one or more Products or Categories to be fetched.
int	hashCode()
void	setAttributes(org.springframework.util.MultiValueMap<String,String> attributes)	Map holding any additional attributes passed in the request not matching any defined properties.
void	setProductPageInfo(org.springframework.data.domain.Pageable productPageInfo)	Pagination info to apply to the products included in the response if this is a request matching a Category.
void	setUris(Set<String> uris)	One or more URIs identifying one or more Products or Categories to be fetched.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

BrowseDetailsRequest

public BrowseDetailsRequest(Set<String> uris,
 org.springframework.data.domain.Pageable productPageInfo,
 org.springframework.util.MultiValueMap<String,String> attributes)

BrowseDetailsRequest

public BrowseDetailsRequest()

Method Details

getUris

public Set<String> getUris()

One or more URIs identifying one or more Products or Categories to be fetched. The list of URIs should only apply to one entity type, i.e., they should all be product URIs or else they should all be category URIs, not a mix of both.

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

Returns:

The URIs identifying the entities to retrieve

getProductPageInfo

public org.springframework.data.domain.Pageable getProductPageInfo()

Pagination info to apply to the products included in the response if this is a request matching a Category.

Returns:

Pagination info to apply to the products included in the response if this is a request matching a Category.

getAttributes

public org.springframework.util.MultiValueMap<String,String> getAttributes()

Map holding any additional attributes passed in the request not matching any defined properties.

setUris

public void setUris(Set<String> uris)

One or more URIs identifying one or more Products or Categories to be fetched. The list of URIs should only apply to one entity type, i.e., they should all be product URIs or else they should all be category URIs, not a mix of both.

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

Parameters:

uris - The URIs identifying the entities to retrieve

setProductPageInfo

public void setProductPageInfo(org.springframework.data.domain.Pageable productPageInfo)

Pagination info to apply to the products included in the response if this is a request matching a Category.

Parameters:

productPageInfo - Pagination info to apply to the products included in the response if this is a request matching a Category.

setAttributes

public void setAttributes(org.springframework.util.MultiValueMap<String,String> attributes)

Map holding any additional attributes passed in the request not matching any defined properties.

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