Package com.broadleafcommerce.catalogbrowse.domain

Class CategoryDetailsRequest

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    CategoryDetailsRequest()
     
    CategoryDetailsRequest(org.springframework.util.MultiValueMap<String,String> parameters, String categoryUrl, String categoryId, boolean hydrateCategoryProductsFromSearch, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    String
    getCategoryId()
    The category ID to match against.
    String
    getCategoryUrl()
    The category URL to match against.
    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
    isHydrateCategoryProductsFromSearch()
    This flag indicates that the category's products should be hydrated from Search Services rather than Catalog.
    void
    setCategoryId(String categoryId)
    The category ID to match against.
    void
    setCategoryUrl(String categoryUrl)
    The category URL to match against.
    void
    setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    The ContextInfo derived from the original request containing tenant and sandbox info.
    void
    setHydrateCategoryProductsFromSearch(boolean hydrateCategoryProductsFromSearch)
    This flag indicates that the category's products should be hydrated from Search Services rather than Catalog.
    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.
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CategoryDetailsRequest

      public CategoryDetailsRequest()

    • CategoryDetailsRequest

      public CategoryDetailsRequest(org.springframework.util.MultiValueMap<String,String> parameters, String categoryUrl, String categoryId, boolean hydrateCategoryProductsFromSearch, com.broadleafcommerce.pricing.client.domain.context.PriceContext priceContext, com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext priceInfoContext, 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

    • getCategoryUrl

      public String getCategoryUrl()
      The category URL to match against. If categoryId is non-null, then it is used instead of this field.

      This is typically left unset when fetching a single Category, but is set when using a BulkCategoryDetailsRequest. Instead, it will be left in the parameters.

      Returns:
      The category URL to match against.

    • getCategoryId

      public String getCategoryId()
      The category ID to match against. If this field is non-null, then it is used instead of categoryUrl.

      This is typically left unset when fetching a single Category, but is set when using a BulkCategoryDetailsRequest. Instead, it will be left in the parameters.

      Returns:
      The category ID to match against.

    • isHydrateCategoryProductsFromSearch

      public boolean isHydrateCategoryProductsFromSearch()
      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

    • 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

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

    • setCategoryUrl

      public void setCategoryUrl(String categoryUrl)
      The category URL to match against. If categoryId is non-null, then it is used instead of this field.

      This is typically left unset when fetching a single Category, but is set when using a BulkCategoryDetailsRequest. Instead, it will be left in the parameters.

      Parameters:
      categoryUrl - The category URL to match against.

    • setCategoryId

      public void setCategoryId(String categoryId)
      The category ID to match against. If this field is non-null, then it is used instead of categoryUrl.

      This is typically left unset when fetching a single Category, but is set when using a BulkCategoryDetailsRequest. Instead, it will be left in the parameters.

      Parameters:
      categoryId - The category ID to match against.

    • setHydrateCategoryProductsFromSearch

      public void setHydrateCategoryProductsFromSearch(boolean hydrateCategoryProductsFromSearch)
      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

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

    • 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