java.lang.Object
- com.broadleafcommerce.catalogbrowse.domain.marketing.MarketingMessageRequest

All Implemented Interfaces:

Serializable
```
public class MarketingMessageRequest
extends Object
implements Serializable
```
Represents the request made to retrieve marketing messages for supplied products and attributes.

Author:

Jon Fleschler (jfleschler)

See Also:

ExternalOfferProvider, MarketingMessage, Serialized Form

Constructor Summary

Constructors
Constructor Description

MarketingMessageRequest()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`List<String>`	`getAppliedOfferIds()`	A list of currently applied offer ids
`List<String>`	`getCartProductIds()`	The ids of any products currently in the customer's cart
`javax.money.MonetaryAmount`	`getCartSubtotal()`	The subtotal of the customer's cart
`String`	`getCategoryId()`	The current category's id
`com.broadleafcommerce.data.tracking.core.context.ContextInfo`	`getContextInfo()`	The `ContextInfo` derived from the original request containing tenant and sandbox info.
`CustomerContext`	`getCustomerContext()`	The customer context information that should be used in determining which offers apply
`List<LineItemDTO>`	`getLineItems()`	A list of hydrated `LineItemDTO`s used by the `ExternalOfferProvider` to retrieve `MarketingMessage`s
`Integer`	`getMaxMessageCount()`	The maximum number of messages for each location and location / product combination
`List<String>`	`getProductIds()`	The ids for all products to retrieve marketing messages for
`int`	`hashCode()`
`void`	`setAppliedOfferIds(List<String> appliedOfferIds)`	A list of currently applied offer ids
`void`	`setCartProductIds(List<String> cartProductIds)`	The ids of any products currently in the customer's cart
`void`	`setCartSubtotal(javax.money.MonetaryAmount cartSubtotal)`	The subtotal of the customer's cart
`void`	`setCategoryId(String categoryId)`	The current category's id
`void`	`setContextInfo(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)`	The `ContextInfo` derived from the original request containing tenant and sandbox info.
`void`	`setCustomerContext(CustomerContext customerContext)`	The customer context information that should be used in determining which offers apply
`void`	`setLineItems(List<LineItemDTO> lineItems)`	A list of hydrated `LineItemDTO`s used by the `ExternalOfferProvider` to retrieve `MarketingMessage`s
`void`	`setMaxMessageCount(Integer maxMessageCount)`	The maximum number of messages for each location and location / product combination
`void`	`setProductIds(List<String> productIds)`	The ids for all products to retrieve marketing messages for
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MarketingMessageRequest
```
public MarketingMessageRequest()
```
- Method Detail
  - 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 CustomerContext getCustomerContext()
```
    The customer context information that should be used in determining which 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<LineItemDTO> getLineItems()
```
    A list of hydrated LineItemDTOs used by the ExternalOfferProvider to retrieve MarketingMessages
    
    Returns:
    
    a list of hydrated LineItemDTOs
  - 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(CustomerContext customerContext)
```
    The customer context information that should be used in determining which 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<LineItemDTO> lineItems)
```
    A list of hydrated LineItemDTOs used by the ExternalOfferProvider 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

Class MarketingMessageRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MarketingMessageRequest

Method Detail

getProductIds

getCategoryId

getCartSubtotal

getCartProductIds

getCustomerContext

getAppliedOfferIds

getMaxMessageCount

getLineItems

getContextInfo

setProductIds

setCategoryId

setCartSubtotal

setCartProductIds

setCustomerContext

setAppliedOfferIds

setMaxMessageCount

setLineItems

setContextInfo

equals

canEqual

hashCode

toString