Package com.broadleafcommerce.catalogbrowse.domain

Class CatalogSearchRequest

java.lang.Object
com.broadleafcommerce.catalogbrowse.domain.CatalogSearchRequest
All Implemented Interfaces:
CatalogEntityDetailsRequest, Serializable
public class CatalogSearchRequest extends Object implements Serializable, CatalogEntityDetailsRequest
DTO containing information pertaining to a request to be sent to the CatalogSearchProvider to retrieve search results.
Author:
Nathan Moore (nathandmoore)
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ASSET_FILTERS_PARAM
     
    static final String
    HYDRATE_FULLY_PARAM
     
    static final String
    TAG_FILTERS_PARAM
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CatalogSearchRequest()
     
    CatalogSearchRequest(org.springframework.util.MultiValueMap<String,String> parameters, 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
    getAssetFilters()
     
    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.
    String
    getTagFilters()
     
    int
    hashCode()
     
    void
    setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    The ContextInfo derived from the original request containing tenant and sandbox info.
    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.
    boolean
    shouldHydrateFully()
     
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • CatalogSearchRequest

      public CatalogSearchRequest()

    • CatalogSearchRequest

      public CatalogSearchRequest(org.springframework.util.MultiValueMap<String,String> parameters, 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

    • shouldHydrateFully

      public boolean shouldHydrateFully()
      Returns:
      Whether products retrieved from Search should have their full product details hydrated.
      Since:
      Catalog Browse Service 2.1.0, Release Train 2.2.0

    • getAssetFilters

      @Nullable public String getAssetFilters()
      Returns:
      RSQL filters to use when hydrating product assets.
      Since:
      Catalog Browse Service 2.1.0, Release Train 2.2.0

    • getTagFilters

      @Nullable public String getTagFilters()
      Returns:
      RSQL filters to use when hydrating product tags.
      Since:
      Catalog Browse Service 2.1.0, Release Train 2.2.0

    • 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

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

    • 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