atg.commerce.promotion
Class PromotionUpsellTools

java.lang.Object
  extended by atg.commerce.promotion.PromotionUpsellTools

public class PromotionUpsellTools
extends java.lang.Object

This tools class is used by the ClosenessQualifierDroplet and the PromotionUpsell targeter to compile lists of closenessQualifiers.


Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Constructor Summary
PromotionUpsellTools()
           
 
Method Summary
 void addClosenessQualifiers(java.util.List pClosenessQualifiers, java.util.List pAllClosenessQualifiers)
           
 java.util.List compileAllClosenessQualifiers(Order pOrder)
          This method gets each of the four types of closenessQualifiers in the current order and compiles them into a single List.
 java.util.List compileItemClosenessQualifiers(Order pOrder)
          Gets the closenessQualifiers from each item in the current order and compiles them into a single List
 java.util.List compileOrderClosenessQualifiers(Order pOrder)
          Returns the closenessQualifiers in the OrderPriceInfo of the current order
 java.util.List compileShippingClosenessQualifiers(Order pOrder)
          Gets the closenessQualifiers from each shipping group in the current order and compiles them into a single List.
 java.util.List compileTaxClosenessQualifiers(Order pOrder)
          Returns the closenessQualifiers in the TaxPriceInfo of the current order
 java.lang.String getShoppingCartPath()
           
 void setShoppingCartPath(java.lang.String pShoppingCartPath)
          The path to the component that holds the current shopping cart
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string

Constructor Detail

PromotionUpsellTools

public PromotionUpsellTools()
Method Detail

setShoppingCartPath

public void setShoppingCartPath(java.lang.String pShoppingCartPath)
The path to the component that holds the current shopping cart

Parameters:
pShoppingCartPath - The path to the component that holds the current shopping cart

getShoppingCartPath

public java.lang.String getShoppingCartPath()
Returns:
The path to the component that holds the current shopping cart

compileAllClosenessQualifiers

public java.util.List compileAllClosenessQualifiers(Order pOrder)
This method gets each of the four types of closenessQualifiers in the current order and compiles them into a single List.

Returns:
a List of all closenessQualifiers in the current order.

addClosenessQualifiers

public void addClosenessQualifiers(java.util.List pClosenessQualifiers,
                                   java.util.List pAllClosenessQualifiers)

compileItemClosenessQualifiers

public java.util.List compileItemClosenessQualifiers(Order pOrder)
Gets the closenessQualifiers from each item in the current order and compiles them into a single List

Returns:
a List of all item closenessQualifiers in the current order

compileShippingClosenessQualifiers

public java.util.List compileShippingClosenessQualifiers(Order pOrder)
Gets the closenessQualifiers from each shipping group in the current order and compiles them into a single List.

Returns:
a List of all shipping closenessQualifiers in the current order.

compileOrderClosenessQualifiers

public java.util.List compileOrderClosenessQualifiers(Order pOrder)
Returns the closenessQualifiers in the OrderPriceInfo of the current order

Returns:
a List of the closenessQualifiers in the OrderPriceInfo of the current order

compileTaxClosenessQualifiers

public java.util.List compileTaxClosenessQualifiers(Order pOrder)
Returns the closenessQualifiers in the TaxPriceInfo of the current order

Returns:
a List of the closenessQualifiers in the TaxPriceInfo of the current order