Class BrowseDetailsRequest
java.lang.Object
com.broadleafcommerce.catalog.domain.commerce.BrowseDetailsRequest
- All Implemented Interfaces:
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:
-
Constructor Summary
ConstructorDescriptionBrowseDetailsRequest
(Set<String> uris, org.springframework.data.domain.Pageable productPageInfo, org.springframework.util.MultiValueMap<String, String> attributes) -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
Map holding any additional attributes passed in the request not matching any defined properties.org.springframework.data.domain.Pageable
Pagination info to apply to the products included in the response if this is a request matching aCategory
.getUris()
One or more URIs identifying one or moreProducts
orCategories
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 aCategory
.void
One or more URIs identifying one or moreProducts
orCategories
to be fetched.toString()
-
Constructor Details
-
BrowseDetailsRequest
-
BrowseDetailsRequest
public BrowseDetailsRequest()
-
-
Method Details
-
getUris
One or more URIs identifying one or moreProducts
orCategories
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 aCategory
.- Returns:
- Pagination info to apply to the products included in the response if this is a
request matching a
Category
.
-
getAttributes
Map holding any additional attributes passed in the request not matching any defined properties. -
setUris
One or more URIs identifying one or moreProducts
orCategories
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 aCategory
.- Parameters:
productPageInfo
- Pagination info to apply to the products included in the response if this is a request matching aCategory
.
-
setAttributes
Map holding any additional attributes passed in the request not matching any defined properties. -
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-