Package com.broadleafcommerce.promotion.offer.domain

Class MarketingMessageRequest

java.lang.Object
com.broadleafcommerce.promotion.offer.domain.MarketingMessageRequest
All Implemented Interfaces:
Serializable
public class MarketingMessageRequest extends Object implements Serializable
A DTO used to make requests to the MarketingMessageResolver, which finds MarketingMessages.
Author:
Jon Fleschler (jfleschler)
See Also:

  • Constructor Details

    • MarketingMessageRequest

      public MarketingMessageRequest()

  • Method Details

    • getProductIds

      public List<String> getProductIds()
      The ids for all products to retrieve marketing messages for
      Returns:
      product ids to retrieve messages for

    • getCategoryId

      public String getCategoryId()
      The current category's id
      Returns:
      the current category's id

    • getCartSubtotal

      public javax.money.MonetaryAmount getCartSubtotal()
      The subtotal of the customer's cart
      Returns:
      the cart's subtotal

    • getCartProductIds

      public List<String> getCartProductIds()
      The ids of any products currently in the customer's cart
      Returns:
      product ids currently in the customer's cart

    • getCustomerContext

      public com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext getCustomerContext()
      The customer context information that should be used in determiningwhich offers apply
      Returns:
      the customer context information that should be used in determining which offers apply

    • getAppliedOfferIds

      public List<String> getAppliedOfferIds()
      A list of currently applied offer ids
      Returns:
      the list of currently applied offer ids

    • getMaxMessageCount

      public Integer getMaxMessageCount()
      The maximum number of messages for each location and location / product combination
      Returns:
      the maximum number of messages

    • getLineItems

      public List<EnhancedLineItem> getLineItems()
      A list of hydrated EnhancedLineItems used by the MarketingMessageResolver to retrieve MarketingMessages
      Returns:
      a list of hydrated EnhancedLineItems

    • getContextInfo

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

    • setProductIds

      public void setProductIds(List<String> productIds)
      The ids for all products to retrieve marketing messages for

    • setCategoryId

      public void setCategoryId(String categoryId)
      The current category's id

    • setCartSubtotal

      public void setCartSubtotal(javax.money.MonetaryAmount cartSubtotal)
      The subtotal of the customer's cart

    • setCartProductIds

      public void setCartProductIds(List<String> cartProductIds)
      The ids of any products currently in the customer's cart

    • setCustomerContext

      public void setCustomerContext(com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext customerContext)
      The customer context information that should be used in determiningwhich offers apply

    • setAppliedOfferIds

      public void setAppliedOfferIds(List<String> appliedOfferIds)
      A list of currently applied offer ids

    • setMaxMessageCount

      public void setMaxMessageCount(Integer maxMessageCount)
      The maximum number of messages for each location and location / product combination

    • setLineItems

      public void setLineItems(List<EnhancedLineItem> lineItems)
      A list of hydrated EnhancedLineItems used by the MarketingMessageResolver to retrieve MarketingMessages

    • 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