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:

  • Constructor Details

    • BrowseDetailsRequest

      public BrowseDetailsRequest(Set<String> uris, boolean hydrateCategoryChoiceProducts, boolean hydrateProductAssets, boolean hydrateRelatedProductCharacteristics, String variantHydrationBehavior, boolean hydratePromotionProducts, boolean hydrateProducts, 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

    • isHydrateCategoryChoiceProducts

      public boolean isHydrateCategoryChoiceProducts()
      Whether to hydrate category products onto categories belonging to ItemChoice ProductOptions.
      Since:
      Catalog Service 2.2.0, Release Train 2.2.0

    • isHydrateProductAssets

      public boolean isHydrateProductAssets()
      Whether to hydrate non-primary product assets onto the ProductDetails response.
      Since:
      Catalog Service 2.2.0, Release Train 2.2.0

    • isHydrateRelatedProductCharacteristics

      public boolean isHydrateRelatedProductCharacteristics()
      Whether to hydrate the Characteristics for the main requested products' related products. The main requested products' characteristics are always hydrated.
      Since:
      Catalog Service 2.2.0, Release Train 2.2.0

    • getVariantHydrationBehavior

      public String getVariantHydrationBehavior()
      Determines the behavior of the system with regard to hydrating Variants onto the ProductDetails when the browse entity resolves to a product or ProductSummaries when resolved to a category. Particularly, whether to hydrate all variants for the products, no variants, or only LiteVariants. By default, this is null and the behavior is instead determined by ProductDetailsProperties.getVariantHydrationBehavior().

      This is equivalent to ProductDetailsRequest.getVariantHydrationBehavior() and CategoryDetailsRequest.getVariantHydrationBehavior() and used as appropriate for the type of entity resolved.

      Since:
      Catalog Service 2.3.0-GA, Release Train 2.3.0-GA

    • isHydratePromotionProducts

      public boolean isHydratePromotionProducts()
      Whether to hydrate promotional products for the requested products if the resolved browse entity is a Product.
      Since:
      Catalog Service 2.3.0-GA, Release Train 2.3.0-GA

    • isHydrateProducts

      public boolean isHydrateProducts()
      Whether to include category products in the response if the entity is a category.
      Since:
      Catalog Service 2.2.0, Release Train 2.2.0

    • 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

    • setHydrateCategoryChoiceProducts

      public void setHydrateCategoryChoiceProducts(boolean hydrateCategoryChoiceProducts)
      Whether to hydrate category products onto categories belonging to ItemChoice ProductOptions.
      Since:
      Catalog Service 2.2.0, Release Train 2.2.0

    • setHydrateProductAssets

      public void setHydrateProductAssets(boolean hydrateProductAssets)
      Whether to hydrate non-primary product assets onto the ProductDetails response.
      Since:
      Catalog Service 2.2.0, Release Train 2.2.0

    • setHydrateRelatedProductCharacteristics

      public void setHydrateRelatedProductCharacteristics(boolean hydrateRelatedProductCharacteristics)
      Whether to hydrate the Characteristics for the main requested products' related products. The main requested products' characteristics are always hydrated.
      Since:
      Catalog Service 2.2.0, Release Train 2.2.0

    • setVariantHydrationBehavior

      public void setVariantHydrationBehavior(String variantHydrationBehavior)
      Determines the behavior of the system with regard to hydrating Variants onto the ProductDetails when the browse entity resolves to a product or ProductSummaries when resolved to a category. Particularly, whether to hydrate all variants for the products, no variants, or only LiteVariants. By default, this is null and the behavior is instead determined by ProductDetailsProperties.getVariantHydrationBehavior().

      This is equivalent to ProductDetailsRequest.getVariantHydrationBehavior() and CategoryDetailsRequest.getVariantHydrationBehavior() and used as appropriate for the type of entity resolved.

      Since:
      Catalog Service 2.3.0-GA, Release Train 2.3.0-GA

    • setHydratePromotionProducts

      public void setHydratePromotionProducts(boolean hydratePromotionProducts)
      Whether to hydrate promotional products for the requested products if the resolved browse entity is a Product.
      Since:
      Catalog Service 2.3.0-GA, Release Train 2.3.0-GA

    • setHydrateProducts

      public void setHydrateProducts(boolean hydrateProducts)
      Whether to include category products in the response if the entity is a category.
      Since:
      Catalog Service 2.2.0, Release Train 2.2.0

    • 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