Package com.broadleafcommerce.catalogbrowse.domain

Class ProductDetailsRequest

java.lang.Object
com.broadleafcommerce.catalogbrowse.domain.ProductDetailsRequest
All Implemented Interfaces:
CatalogEntityDetailsRequest, Serializable
public class ProductDetailsRequest extends Object implements Serializable, CatalogEntityDetailsRequest
DTO containing information pertaining to a request to be sent to the CatalogProvider to retrieve a product's details.
Author:
Nathan Moore (nathandmoore)
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProductDetailsRequest()
     
    ProductDetailsRequest(org.springframework.util.MultiValueMap<String,String> parameters, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, boolean skipPricing, boolean skipInventory, boolean hydrateProductAssets, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    com.broadleafcommerce.data.tracking.core.context.ContextInfo
    getContextInfo()
    The ContextInfo derived from the original request containing tenant and sandbox info.
    org.springframework.util.MultiValueMap<String,String>
    getParameters()
    The parameters included in the original request that don't need to be enumerated in this service but passed along to the provider.
    com.broadleafcommerce.pricing.client.domain.context.PriceContext
    getPriceContext()
    The PriceContext from the original request containing general pricing info.
    com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext
    getPriceInfoContext()
    The PriceInfoContext from the original request containing info specific for getting PriceInfos such as prefetched PriceLists.
    int
    hashCode()
     
    boolean
    isHydrateProductAssets()
    Whether to hydrate the product's non-primary assets.
    boolean
    isSkipInventory()
    Whether to skip inventory for the products.
    boolean
    isSkipPricing()
    Whether to skip pricing for the products.
    void
    setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    The ContextInfo derived from the original request containing tenant and sandbox info.
    void
    setHydrateProductAssets(boolean hydrateProductAssets)
    Whether to hydrate the product's non-primary assets.
    void
    setParameters(org.springframework.util.MultiValueMap<String,String> parameters)
    The parameters included in the original request that don't need to be enumerated in this service but passed along to the provider.
    void
    setPriceContext(com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext)
    The PriceContext from the original request containing general pricing info.
    void
    setPriceInfoContext(com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext)
    The PriceInfoContext from the original request containing info specific for getting PriceInfos such as prefetched PriceLists.
    void
    setSkipInventory(boolean skipInventory)
    Whether to skip inventory for the products.
    void
    setSkipPricing(boolean skipPricing)
    Whether to skip pricing for the products.
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ProductDetailsRequest

      public ProductDetailsRequest()

    • ProductDetailsRequest

      public ProductDetailsRequest(org.springframework.util.MultiValueMap<String,String> parameters, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, boolean skipPricing, boolean skipInventory, boolean hydrateProductAssets, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

  • Method Details

    • getParameters

      public org.springframework.util.MultiValueMap<String,String> getParameters()
      The parameters included in the original request that don't need to be enumerated in this service but passed along to the provider.
      Specified by:
      getParameters in interface CatalogEntityDetailsRequest
      Returns:
      The parameters included in the original request

    • getPriceContext

      public com.broadleafcommerce.pricing.client.domain.context.PriceContext getPriceContext()
      The PriceContext from the original request containing general pricing info.
      Specified by:
      getPriceContext in interface CatalogEntityDetailsRequest
      Returns:
      PriceContext from the original request

    • getPriceInfoContext

      public com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext getPriceInfoContext()
      The PriceInfoContext from the original request containing info specific for getting PriceInfos such as prefetched PriceLists.
      Specified by:
      getPriceInfoContext in interface CatalogEntityDetailsRequest
      Returns:
      The PriceInfoContext from the original request

    • isSkipPricing

      public boolean isSkipPricing()
      Whether to skip pricing for the products.

      Pricing may be skipped if the calling service prices the products separately.

    • isSkipInventory

      public boolean isSkipInventory()
      Whether to skip inventory for the products.

      Inventory may be skipped and the returned products will not contain inventory availability details.

    • isHydrateProductAssets

      public boolean isHydrateProductAssets()
      Whether to hydrate the product's non-primary assets.
      Since:
      Catalog Browse Service 2.1.0, Release Train 2.2.0

    • getContextInfo

      public com.broadleafcommerce.data.tracking.core.context.ContextInfo getContextInfo()
      The ContextInfo derived from the original request containing tenant and sandbox info.
      Specified by:
      getContextInfo in interface CatalogEntityDetailsRequest
      Returns:
      The ContextInfo derived from the original request

    • setParameters

      public void setParameters(org.springframework.util.MultiValueMap<String,String> parameters)
      The parameters included in the original request that don't need to be enumerated in this service but passed along to the provider.

    • setPriceContext

      public void setPriceContext(com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext)
      The PriceContext from the original request containing general pricing info.

    • setPriceInfoContext

      public void setPriceInfoContext(com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext)
      The PriceInfoContext from the original request containing info specific for getting PriceInfos such as prefetched PriceLists.

    • setSkipPricing

      public void setSkipPricing(boolean skipPricing)
      Whether to skip pricing for the products.

      Pricing may be skipped if the calling service prices the products separately.

    • setSkipInventory

      public void setSkipInventory(boolean skipInventory)
      Whether to skip inventory for the products.

      Inventory may be skipped and the returned products will not contain inventory availability details.

    • setHydrateProductAssets

      public void setHydrateProductAssets(boolean hydrateProductAssets)
      Whether to hydrate the product's non-primary assets.
      Since:
      Catalog Browse Service 2.1.0, Release Train 2.2.0

    • setContextInfo

      public void setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      The ContextInfo derived from the original request containing tenant and sandbox info.

    • 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