Package com.broadleafcommerce.catalogbrowse.domain

Class BrowseDetailsRequest

java.lang.Object
com.broadleafcommerce.catalogbrowse.domain.BrowseDetailsRequest
All Implemented Interfaces:
CatalogEntityDetailsRequest, Serializable
public class BrowseDetailsRequest extends Object implements Serializable, CatalogEntityDetailsRequest
DTO containing information pertaining to a request to be sent to the CatalogProvider or ContentProvider to retrieve a browse entity's details such as for a Product, Category, ContentItem. This is used when the caller does not know the type of entity to request but has some parameters like a URI to match against. The service will dynamically determine the correct entity to respond with.
Author:
Nathan Moore (nathandmoore)
See Also:

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    ContentContext
    getContentContext()
    Any contextual information needed to resolve targeted content.
    com.broadleafcommerce.data.tracking.core.context.ContextInfo
    getContextInfo()
     
    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()
     
    int
    hashCode()
     
    boolean
    isHydrateCategoryProductsFromSearch()
    If the browse entity resolves to a category, this flag indicates that the category's products should be hydrated from Search Services rather than Catalog.
    boolean
    isHydrateCategoryProductsOntoContentItems()
    If any content items reference categories, this flag indicates that the categories' products should be hydrated.
    boolean
    isSkipInventory()
    Whether to skip inventory for the products.
    boolean
    isSkipPricing()
    Whether to skip pricing for the products.
    void
    setContentContext(ContentContext contentContext)
    Any contextual information needed to resolve targeted content.
    void
    setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     
    void
    setHydrateCategoryProductsFromSearch(boolean hydrateCategoryProductsFromSearch)
    If the browse entity resolves to a category, this flag indicates that the category's products should be hydrated from Search Services rather than Catalog.
    void
    setHydrateCategoryProductsOntoContentItems(boolean hydrateCategoryProductsOntoContentItems)
    If any content items reference categories, this flag indicates that the categories' products should be hydrated.
    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)
     
    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

    • BrowseDetailsRequest

      public BrowseDetailsRequest()

    • BrowseDetailsRequest

      public BrowseDetailsRequest(org.springframework.util.MultiValueMap<String,String> parameters, boolean hydrateCategoryProductsFromSearch, boolean hydrateCategoryProductsOntoContentItems, ContentContext contentContext, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, boolean skipPricing, boolean skipInventory, 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

    • isHydrateCategoryProductsFromSearch

      public boolean isHydrateCategoryProductsFromSearch()
      If the browse entity resolves to a category, this flag indicates that the category's products should be hydrated from Search Services rather than Catalog.

      This is only used in Catalog Browse Service and not passed downstream as a parameter.

      Since:
      Catalog Browse Service 2.1.0, Release Train 2.2.0

    • isHydrateCategoryProductsOntoContentItems

      public boolean isHydrateCategoryProductsOntoContentItems()
      If any content items reference categories, this flag indicates that the categories' products should be hydrated.

      This is only used in Catalog Browse Service and not passed downstream as a parameter, instead it will be translated in the appropriate pagination params or trigger relevant business logic.

      Since:
      Catalog Browse Service 2.1.0, Release Train 2.2.0

    • getContentContext

      public ContentContext getContentContext()
      Any contextual information needed to resolve targeted content.

      If present, this information is used during content zone resolution.

    • 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()
      Specified by:
      getPriceInfoContext in interface CatalogEntityDetailsRequest

    • 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.

    • getContextInfo

      public com.broadleafcommerce.data.tracking.core.context.ContextInfo getContextInfo()
      Specified by:
      getContextInfo in interface CatalogEntityDetailsRequest

    • 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.

    • setHydrateCategoryProductsFromSearch

      public void setHydrateCategoryProductsFromSearch(boolean hydrateCategoryProductsFromSearch)
      If the browse entity resolves to a category, this flag indicates that the category's products should be hydrated from Search Services rather than Catalog.

      This is only used in Catalog Browse Service and not passed downstream as a parameter.

      Since:
      Catalog Browse Service 2.1.0, Release Train 2.2.0

    • setHydrateCategoryProductsOntoContentItems

      public void setHydrateCategoryProductsOntoContentItems(boolean hydrateCategoryProductsOntoContentItems)
      If any content items reference categories, this flag indicates that the categories' products should be hydrated.

      This is only used in Catalog Browse Service and not passed downstream as a parameter, instead it will be translated in the appropriate pagination params or trigger relevant business logic.

      Since:
      Catalog Browse Service 2.1.0, Release Train 2.2.0

    • setContentContext

      public void setContentContext(ContentContext contentContext)
      Any contextual information needed to resolve targeted content.

      If present, this information is used during content zone resolution.

    • 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)

    • 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.

    • setContextInfo

      public void setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

    • 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