Package com.ibm.commerce.marketing.promotion.condition

Provides classes and interfaces to define promotion condition, filter, filter chain, constraint, pattern and weighted range.

See: Description

  • Interface Summary 
    Interface Description
    Condition
    The interface Condition is used to define a requirement of a promotion that must be satisfied before the corresponding rewards can be calculated and applied to an order.
    Filter
    A filter is a set of business logic that is applied to a LineItemSet, and results in a second LineItemSet that is a subset of the original LineItemSet.
    PatternFilter
    A Pattern Filter is a set of logic that eliminates matched patterns that do not satisfy the conditions set out in a Pattern Filter.
  • Class Summary 
    Class Description
    AlwaysTrueCondition
    This Condition class always returns true, that is the conditions set out are always satisfied.
    XML Snippet of AlwaysTrueCondition is as follows:
    CatalogEntryAttributeFilter
    CatalogEntryAttributeFilter class filters LineItemSet based on CatalogEntry attribute values of the LineItems.
    CategoryFilter
    CategoryFilter class filters LineItemSet based on the Categories to which the AssociatedOrderItem (of the LineItemSet) belong to.
    Constraint
    A block of XML that describes pattern elements, which are based on a list of filters.
    DummyFilter
    DummyFilter class provides dummy implementation for Filter interface.
    DummyPatternFilter
    DummyPatternFilter class provides dummy implementation for PatternFilter interface.
    DummyPurchaseCondition
    DummyPurchaseCondition class provides dummy implementation for Condition interface.
    FilterChain
    FilterChain encapsulates a collection of Filter objects.
    FreeGiftPurchaseCondition
    The FreeGiftPurchaseCondition is a customized pattern definition for free gift promotions.
    ItemSortingFilter
    ItemSortingFilter sorts the input LineItemSet according to the order item price (before any discounts), using the specified SortingMethod and returns the ordered LineItems.
    ManufacturerFilter
    ManufacturerFilter class filters LineItemSet based on the Manufacturer of the LineItems (of the LineItemSet).
    MultiSKUFilter
    MultiSKUFilter class filters LineItemSet based on CatalogEntry and parent CatalogEntrys of the LineItems.
    OQTEligibleAffectedItemFilter
    This filter is used to search through the input LineItems and return those LineItems which can be affected but have not yet been affected by the current promotion.
    OrderedQuantityFilter
    OrderedQuantityFilter sorts the LineItemSet and returns the specified quantity of either highest priced or lowest priced LineItems.
    OrderQualifyingTotalBasedPurchaseCondition
    The OrderQualifyingTotalBasedPurchaseCondition sets out the conditions of an exact or minimum order total value to a target of subtotal, tax, shipping or shipping tax before the corresponding rewards can be calculated and applied to an order.
    Pattern
    Pattern is the approach to group a set of products and items in the shop cart in order to identify if the purchase condition criteria is met.
    PaymentTypeFilter
    PaymentTypeFilter class filters LineItemSet based on payment method of the order.
    PriceComparisonFilter Deprecated
    please use OrderedQuantityFilter instead
    PriceConverter
    This class is used to convert the amount from one currency to another.
    PriceThresholdFilter
    PriceThresholdFilter class filters LineItemSet based on the Price of the LineItems (of the LineItemSet).
    PromotionCodeCondition
    The PromotionCodeCondition class is used to check if a promotion code has been specified for the promotion under evaluation.
    PurchaseCondition
    Purchase condition specifies the purchases a shopper has to make before the shopper can qualify for a promotion.
    QuantityBasedGroupingFilter
    QuantityBasedGroupingFilter selects a sub set of order items based on defined quantity related selection logic.
    QuantitySelectionFilter
    QuantitySelectionFilter class groups the items LineItemSet in groups of number specified by the value of the GroupOf element.
    ShippingModeFilter
    ShippingModeFilter class filters LineItemSet based on the Shipping Mode to which LineItems (of the LineItemSet) belong to.
    TargetingCondition
    TargetingCondition specifies the customer profiles to which the promotion will apply.
    TotalCostFilter
    TotalCostFilter class filters LineItemSet based on the total cost of the items in the LineItemSet.
    TotalCostPatternFilter
    TotalCostPatternFilter class filters LineItemSet based on the Total Cost of the items LineItemSet.
    WeightedRange
    A WeightedRange is used to define the quantity requirement of a pattern definition.
  • Exception Summary 
    Exception Description
    PromotionConditionEvaluationException
    This exception is thrown if the evaluation of a Condition encounters unexpected problems.

Package com.ibm.commerce.marketing.promotion.condition Description

Provides classes and interfaces to define promotion condition, filter, filter chain, constraint, pattern and weighted range.