CartRule (BroadleafCommerce Cart Rules 2.2.0-GA API)

All Superinterfaces:

org.broadleafcommerce.common.copy.MultiTenantCloneable<CartRule>, Serializable, org.broadleafcommerce.common.persistence.Status

All Known Implementing Classes:

CartRuleImpl
```
public interface CartRule
extends org.broadleafcommerce.common.persistence.Status, Serializable, org.broadleafcommerce.common.copy.MultiTenantCloneable<CartRule>
```
Interface for defining rules with associated CartRuleActions to take at certain points in the Add to Cart workflow.

Author:

Jon Fleschler (jfleschler)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Date`	`getActiveEndDate()` Returns the active end date of this `CartRule`
`Date`	`getActiveStartDate()` Returns the active start date of this `CartRule`
`List<CartRuleAction>`	`getCartRuleActions()` Returns a list of `CartRuleAction`s associated with this `CartRule`
`List<CartRuleCustomerSegmentXref>`	`getCustomerSegmentXrefs()` Returns a list of `CartRuleCustomerSegmentXref`s associated with this `CartRule`
`ExecutionTimeType`	`getExecutionTimeType()` Returns the `ExecutionTimeType` associated with this `CartRule`
`Long`	`getId()` Returns the `CartRule`s id
`String`	`getName()` Returns the `CartRule`s name
`Set<CartRuleQualifyingItemCriteriaXref>`	`getQualifyingItemCriteria()` Returns the set of `CartRuleQualifyingItemCriteriaXref`s associated with this `CartRule`
`Set<CartRuleQualifyingOrderCriteriaXref>`	`getQualifyingOrderCriteria()` Returns the set of `CartRuleQualifyingOrderCriteriaXref`s associated with this `CartRule`
`List<CartRuleAction>`	`getReversibleCartRuleActions()` Returns the list of `CartRuleAction`s that are reversible
`Integer`	`getTimesPerCustomer()` Returns the number of times this `CartRule` can trigger per Customer
`Integer`	`getTimesPerOrder()` Returns the number of times this `CartRule` can trigger per Order
`boolean`	`hasCartRuleActions()` Returns whether or not the `CartRule` has any associated `CartRuleAction`s
`void`	`setActiveEndDate(Date activeEndDate)` Sets the active end date for this `CartRule`
`void`	`setActiveStartDate(Date activeStartDate)` Sets the active start date for this `CartRule`
`void`	`setCartRuleActions(List<CartRuleAction> cartRuleActions)` Sets the list of `CartRuleAction`s to be associated with this `CartRule`
`void`	`setCustomerSegmentXrefs(List<CartRuleCustomerSegmentXref> customerSegmentXrefs)` Sets the list of `CartRuleCustomerSegmentXref`s to be associated with this `CartRule`
`void`	`setExecutionTimeType(ExecutionTimeType executionTimeType)` Sets the `ExecutionTimeType` to be associated with this `CartRule`
`void`	`setId(Long id)` Sets the `CartRule`s id
`void`	`setName(String name)` Sets the `CartRule`s name
`void`	`setQualifyingItemCriteria(Set<CartRuleQualifyingItemCriteriaXref> qualifyingItemCriteria)` Sets the set of `CartRuleQualifyingItemCriteriaXref`s to be associated with this `CartRule`
`void`	`setQualifyingOrderCriteria(Set<CartRuleQualifyingOrderCriteriaXref> qualifyingOrderCriteria)` Sets the set of `CartRuleQualifyingOrderCriteriaXref`s to be associated with this `CartRule`
`void`	`setTimesPerCustomer(Integer timesPerCustomer)` Returns the number of times this `CartRule` can trigger per Customer
`void`	`setTimesPerOrder(Integer timesPerOrder)` Sets the number of times this `CartRule` can trigger per Order

Methods inherited from interface org.broadleafcommerce.common.persistence.Status
getArchived, isActive, setArchived

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable
createOrRetrieveCopyInstance

- Method Detail
  - getId
```
Long getId()
```
    Returns the CartRules id
    
    Returns:
  - setId
```
void setId(Long id)
```
    Sets the CartRules id
  - getName
```
String getName()
```
    Returns the CartRules name
    
    Returns:
  - setName
```
void setName(String name)
```
    Sets the CartRules name
  - getExecutionTimeType
```
ExecutionTimeType getExecutionTimeType()
```
    Returns the ExecutionTimeType associated with this CartRule
    
    Returns:
  - setExecutionTimeType
```
void setExecutionTimeType(ExecutionTimeType executionTimeType)
```
    Sets the ExecutionTimeType to be associated with this CartRule
  - getQualifyingItemCriteria
```
Set<CartRuleQualifyingItemCriteriaXref> getQualifyingItemCriteria()
```
    Returns the set of CartRuleQualifyingItemCriteriaXrefs associated with this CartRule
    
    Returns:
  - setQualifyingItemCriteria
```
void setQualifyingItemCriteria(Set<CartRuleQualifyingItemCriteriaXref> qualifyingItemCriteria)
```
    Sets the set of CartRuleQualifyingItemCriteriaXrefs to be associated with this CartRule
  - getQualifyingOrderCriteria
```
Set<CartRuleQualifyingOrderCriteriaXref> getQualifyingOrderCriteria()
```
    Returns the set of CartRuleQualifyingOrderCriteriaXrefs associated with this CartRule
    
    Returns:
  - setQualifyingOrderCriteria
```
void setQualifyingOrderCriteria(Set<CartRuleQualifyingOrderCriteriaXref> qualifyingOrderCriteria)
```
    Sets the set of CartRuleQualifyingOrderCriteriaXrefs to be associated with this CartRule
  - getCartRuleActions
```
List<CartRuleAction> getCartRuleActions()
```
    Returns a list of CartRuleActions associated with this CartRule
    
    Returns:
  - setCartRuleActions
```
void setCartRuleActions(List<CartRuleAction> cartRuleActions)
```
    Sets the list of CartRuleActions to be associated with this CartRule
  - hasCartRuleActions
```
boolean hasCartRuleActions()
```
    Returns whether or not the CartRule has any associated CartRuleActions
    
    Returns:
  - getCustomerSegmentXrefs
```
List<CartRuleCustomerSegmentXref> getCustomerSegmentXrefs()
```
    Returns a list of CartRuleCustomerSegmentXrefs associated with this CartRule
    
    Returns:
  - setCustomerSegmentXrefs
```
void setCustomerSegmentXrefs(List<CartRuleCustomerSegmentXref> customerSegmentXrefs)
```
    Sets the list of CartRuleCustomerSegmentXrefs to be associated with this CartRule
    
    Parameters:
    
    customerSegmentXrefs -
  - getActiveStartDate
```
Date getActiveStartDate()
```
    Returns the active start date of this CartRule
    
    Returns:
  - setActiveStartDate
```
void setActiveStartDate(Date activeStartDate)
```
    Sets the active start date for this CartRule
  - getActiveEndDate
```
Date getActiveEndDate()
```
    Returns the active end date of this CartRule
    
    Returns:
  - setActiveEndDate
```
void setActiveEndDate(Date activeEndDate)
```
    Sets the active end date for this CartRule
  - getTimesPerOrder
```
Integer getTimesPerOrder()
```
    Returns the number of times this CartRule can trigger per Order
    
    Returns:
  - setTimesPerOrder
```
void setTimesPerOrder(Integer timesPerOrder)
```
    Sets the number of times this CartRule can trigger per Order
    
    Parameters:
    
    timesPerOrder -
  - getTimesPerCustomer
```
Integer getTimesPerCustomer()
```
    Returns the number of times this CartRule can trigger per Customer
    
    Returns:
  - setTimesPerCustomer
```
void setTimesPerCustomer(Integer timesPerCustomer)
```
    Returns the number of times this CartRule can trigger per Customer
  - getReversibleCartRuleActions
```
List<CartRuleAction> getReversibleCartRuleActions()
```
    Returns the list of CartRuleActions that are reversible
    
    Returns:

Interface CartRule

Method Summary

Methods inherited from interface org.broadleafcommerce.common.persistence.Status

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

Method Detail

getId

setId

getName

setName

getExecutionTimeType

setExecutionTimeType

getQualifyingItemCriteria

setQualifyingItemCriteria

getQualifyingOrderCriteria

setQualifyingOrderCriteria

getCartRuleActions

setCartRuleActions

hasCartRuleActions

getCustomerSegmentXrefs

setCustomerSegmentXrefs

getActiveStartDate

setActiveStartDate

getActiveEndDate

setActiveEndDate

getTimesPerOrder

setTimesPerOrder

getTimesPerCustomer

setTimesPerCustomer

getReversibleCartRuleActions