ShoppingCartModifierConfiguration (ATG Java API)

java.lang.Object
- atg.commerce.order.ShoppingCartModifierConfiguration

Direct Known Subclasses:

B2BShoppingCartModifierConfiguration
```
public class ShoppingCartModifierConfiguration
extends java.lang.Object
```
This class is designed to be configured as a session scoped component which stores configuration parameters for the ShoppingCartFormHandler. The form handler can be configured directory, however there are a large number of configuration properties to be set. Since, typically, this form handler is request scoped this causes some overhead on every single request. In using this component all the configuration parameters are configured once per session, and then the form handler only has to resolve one component.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_VERSION
Class version string

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string

Constructor Summary

Constructors
Constructor and Description

ShoppingCartModifierConfiguration()
Constructs an instanceof ShoppingCartModifierConfiguration

Constructors
Constructor and Description
`ShoppingCartModifierConfiguration()` Constructs an instanceof ShoppingCartModifierConfiguration

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAddItemToOrderChainId()` Returns property AddItemToOrderChainId
`java.lang.String`	`getAddItemToOrderPricingOp()` Returns the pricing operation that should be performed when an item is added to the order
`CatalogTools`	`getCatalogTools()` Returns property CatalogTools
`ClaimableManager`	`getClaimableManager()` Returns property ClaimableManager
`ClaimableTools`	`getClaimableTools()` Returns property ClaimableTools
`CommerceProfileTools`	`getCommerceProfileTools()` Returns property CommerceProfileTools
`java.util.Locale`	`getDefaultLocale()` Returns property DefaultLocale
`java.lang.String`	`getDeleteItemsFromOrderPricingOp()` Returns the pricing operation that should be performed when an item is deleted from the order
`GiftlistManager`	`getGiftlistManager()` The giftlist that an item was added from
`ClientLockManager`	`getLocalLockManager()` Return the lock manager to use if `useLocksAroundTransactions` is true in `OrderModifierFormHandler` and its subclasses.
`java.lang.String`	`getModifyOrderPricingOp()` Returns the pricing operation that should be performed when the order is updated
`java.lang.String`	`getMoveToConfirmationChainId()` Returns property MoveToConfirmationChainId
`java.lang.String`	`getMoveToPurchaseInfoChainId()` Returns property MoveToPurchaseInfoChainId
`SimpleOrderManager`	`getOrderManager()` Returns property OrderManager
`PipelineManager`	`getPipelineManager()` Returns property PipelineManager
`RepositoryItem`	`getProfile()` Returns property Profile
`CommercePropertyManager`	`getPropertyManager()` Returns property PropertyManager
`java.lang.String`	`getRepriceOrder()` Returns the pricing operation that should be performed by the reprice order handler method.
`java.lang.String`	`getRepriceOrderChainId()` Returns property RepriceOrderChainId
`java.lang.String`	`getSetOrderChainId()` Returns property SetOrderChainId
`OrderHolder`	`getShoppingCart()` Returns property ShoppingCart
`java.lang.String`	`getSoftGoodShippingGroupName()` Returns property SoftGoodShippingGroupName
`javax.transaction.TransactionManager`	`getTransactionManager()` Returns property TransactionManager
`PricingModelHolder`	`getUserPricingModels()` Returns property UserPricingModels
`java.lang.String`	`getValidateShippingGroupsChainId()` Return the validateShippingGroupsChainId property.
`void`	`setAddItemToOrderChainId(java.lang.String pAddItemToOrderChainId)` Sets property AddItemToOrderChainId
`void`	`setAddItemToOrderPricingOp(java.lang.String pAddItemToOrderPricingOp)` This property should be set to the type of pricing operation that should be executed when an item is added to the order.
`void`	`setCatalogTools(CatalogTools pCatalogTools)` Sets property CatalogTools
`void`	`setClaimableManager(ClaimableManager pClaimableManager)` Sets property ClaimableManager
`void`	`setClaimableTools(ClaimableTools pClaimableTools)` Sets property ClaimableTools
`void`	`setCommerceProfileTools(CommerceProfileTools pCommerceProfileTools)` Sets property CommerceProfileTools
`void`	`setDefaultLocale(java.util.Locale pDefaultLocale)` Sets property DefaultLocale
`void`	`setDeleteItemsFromOrderPricingOp(java.lang.String pDeleteItemsFromOrderPricingOp)` This property should be set to the type of pricing operation that should be executed when an item is deleted from the order.
`void`	`setGiftlistManager(GiftlistManager pGiftlistManager)`
`void`	`setLocalLockManager(ClientLockManager pLocalLockManager)` Specify the lock manager to use if `useLocksAroundTransactions` is true in `OrderModifierFormHandler` and its subclasses.
`void`	`setModifyOrderPricingOp(java.lang.String pModifyOrderPricingOp)` This property should be set to the type of pricing operation that should be executed when the order is updated without adding or removing an item (e.g.
`void`	`setMoveToConfirmationChainId(java.lang.String pMoveToConfirmationChainId)` Sets property MoveToConfirmationChainId
`void`	`setMoveToPurchaseInfoChainId(java.lang.String pMoveToPurchaseInfoChainId)` Sets property MoveToPurchaseInfoChainId
`void`	`setOrderManager(SimpleOrderManager pOrderManager)` Sets property OrderManager
`void`	`setPipelineManager(PipelineManager pPipelineManager)` Sets property PipelineManager
`void`	`setProfile(RepositoryItem pProfile)` Sets property Profile
`void`	`setPropertyManager(CommercePropertyManager pPropertyManager)` Sets property PropertyManager
`void`	`setRepriceOrder(java.lang.String pRepriceOrder)` Corresponds to the handle reprice order method.
`void`	`setRepriceOrderChainId(java.lang.String pRepriceOrderChainId)` Sets property RepriceOrderChainId
`void`	`setSetOrderChainId(java.lang.String pSetOrderChainId)` Sets property SetOrderChainId
`void`	`setShoppingCart(OrderHolder pShoppingCart)` Sets property ShoppingCart
`void`	`setSoftGoodShippingGroupName(java.lang.String pSoftGoodShippingGroupName)` Sets property SoftGoodShippingGroupName
`void`	`setTransactionManager(javax.transaction.TransactionManager pTransactionManager)` Sets property TransactionManager
`void`	`setUserPricingModels(PricingModelHolder pUserPricingModels)` Sets property UserPricingModels
`void`	`setValidateShippingGroupsChainId(java.lang.String pValidateShippingGroupsChainId)` Set the validateShippingGroupsChainId property.

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
  - ShoppingCartModifierConfiguration
```
public ShoppingCartModifierConfiguration()
```
    Constructs an instanceof ShoppingCartModifierConfiguration
- Method Detail
  - setTransactionManager
```
public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
```
    Sets property TransactionManager
  - getTransactionManager
```
public javax.transaction.TransactionManager getTransactionManager()
```
    Returns property TransactionManager
  - setGiftlistManager
```
public void setGiftlistManager(GiftlistManager pGiftlistManager)
```
  - getGiftlistManager
```
public GiftlistManager getGiftlistManager()
```
    The giftlist that an item was added from
  - setUserPricingModels
```
public void setUserPricingModels(PricingModelHolder pUserPricingModels)
```
    Sets property UserPricingModels
  - getUserPricingModels
```
public PricingModelHolder getUserPricingModels()
```
    Returns property UserPricingModels
  - setShoppingCart
```
public void setShoppingCart(OrderHolder pShoppingCart)
```
    Sets property ShoppingCart
  - getShoppingCart
```
public OrderHolder getShoppingCart()
```
    Returns property ShoppingCart
  - setPipelineManager
```
public void setPipelineManager(PipelineManager pPipelineManager)
```
    Sets property PipelineManager
  - getPipelineManager
```
public PipelineManager getPipelineManager()
```
    Returns property PipelineManager
  - setAddItemToOrderChainId
```
public void setAddItemToOrderChainId(java.lang.String pAddItemToOrderChainId)
```
    Sets property AddItemToOrderChainId
  - getAddItemToOrderChainId
```
public java.lang.String getAddItemToOrderChainId()
```
    Returns property AddItemToOrderChainId
  - setMoveToPurchaseInfoChainId
```
public void setMoveToPurchaseInfoChainId(java.lang.String pMoveToPurchaseInfoChainId)
```
    Sets property MoveToPurchaseInfoChainId
  - getMoveToPurchaseInfoChainId
```
public java.lang.String getMoveToPurchaseInfoChainId()
```
    Returns property MoveToPurchaseInfoChainId
  - setMoveToConfirmationChainId
```
public void setMoveToConfirmationChainId(java.lang.String pMoveToConfirmationChainId)
```
    Sets property MoveToConfirmationChainId
  - getMoveToConfirmationChainId
```
public java.lang.String getMoveToConfirmationChainId()
```
    Returns property MoveToConfirmationChainId
  - setSetOrderChainId
```
public void setSetOrderChainId(java.lang.String pSetOrderChainId)
```
    Sets property SetOrderChainId
  - getSetOrderChainId
```
public java.lang.String getSetOrderChainId()
```
    Returns property SetOrderChainId
  - setRepriceOrderChainId
```
public void setRepriceOrderChainId(java.lang.String pRepriceOrderChainId)
```
    Sets property RepriceOrderChainId
  - getRepriceOrderChainId
```
public java.lang.String getRepriceOrderChainId()
```
    Returns property RepriceOrderChainId
  - setValidateShippingGroupsChainId
```
public void setValidateShippingGroupsChainId(java.lang.String pValidateShippingGroupsChainId)
```
    Set the validateShippingGroupsChainId property.
  - getValidateShippingGroupsChainId
```
public java.lang.String getValidateShippingGroupsChainId()
```
    Return the validateShippingGroupsChainId property.
  - setProfile
```
public void setProfile(RepositoryItem pProfile)
```
    Sets property Profile
  - getProfile
```
public RepositoryItem getProfile()
```
    Returns property Profile
  - setOrderManager
```
public void setOrderManager(SimpleOrderManager pOrderManager)
```
    Sets property OrderManager
  - getOrderManager
```
public SimpleOrderManager getOrderManager()
```
    Returns property OrderManager
  - setCatalogTools
```
public void setCatalogTools(CatalogTools pCatalogTools)
```
    Sets property CatalogTools
  - getCatalogTools
```
public CatalogTools getCatalogTools()
```
    Returns property CatalogTools
  - setDefaultLocale
```
public void setDefaultLocale(java.util.Locale pDefaultLocale)
```
    Sets property DefaultLocale
  - getDefaultLocale
```
public java.util.Locale getDefaultLocale()
```
    Returns property DefaultLocale
  - setClaimableManager
```
public void setClaimableManager(ClaimableManager pClaimableManager)
```
    Sets property ClaimableManager
  - getClaimableManager
```
public ClaimableManager getClaimableManager()
```
    Returns property ClaimableManager
  - setClaimableTools
```
public void setClaimableTools(ClaimableTools pClaimableTools)
```
    Sets property ClaimableTools
  - getClaimableTools
```
public ClaimableTools getClaimableTools()
```
    Returns property ClaimableTools
  - setCommerceProfileTools
```
public void setCommerceProfileTools(CommerceProfileTools pCommerceProfileTools)
```
    Sets property CommerceProfileTools
  - getCommerceProfileTools
```
public CommerceProfileTools getCommerceProfileTools()
```
    Returns property CommerceProfileTools
  - setPropertyManager
```
public void setPropertyManager(CommercePropertyManager pPropertyManager)
```
    Sets property PropertyManager
  - getPropertyManager
```
public CommercePropertyManager getPropertyManager()
```
    Returns property PropertyManager
  - setSoftGoodShippingGroupName
```
public void setSoftGoodShippingGroupName(java.lang.String pSoftGoodShippingGroupName)
```
    Sets property SoftGoodShippingGroupName
  - getSoftGoodShippingGroupName
```
public java.lang.String getSoftGoodShippingGroupName()
```
    Returns property SoftGoodShippingGroupName
  - setRepriceOrder
```
public void setRepriceOrder(java.lang.String pRepriceOrder)
```
    Corresponds to the handle reprice order method. This property should be set to the type of pricing operation that should be executed when the reprice order handler method is invoked. The operations which are acceptable are defined in the atg.commerce.pricing.PricingConstants interface. They include:
    - PricingConstants.OP_REPRICE_ORDER_TOTAL -> ORDER_TOTAL
    - PricingConstants.OP_REPRICE_ORDER_SUBTOTAL -> ORDER_SUBTOTAL
    - PricingConstants.OP_REPRICE_ORDER_SUBTOTAL_SHIPPING -> ORDER_SUBTOTAL_SHIPPING
    - PricingConstants.OP_REPRICE_ORDER_SUBTOTAL_TAX -> ORDER_SUBTOTAL_TAX
    - PricingConstants.OP_REPRICE_ITEMS -> ITEMS
    - PricingConstants.OP_REPRICE_SHIPPING -> SHIPPING
    - PricingConstants.OP_REPRICE_ORDER -> ORDER
    - PricingConstants.OP_REPRICE_TAX -> TAX
    - PricingConstants.OP_NO_REPRICE -> NO_REPRICE
    If this value is null, then the system will default to ORDER_TOTAL.
  - getRepriceOrder
```
public java.lang.String getRepriceOrder()
```
    Returns the pricing operation that should be performed by the reprice order handler method.
  - setAddItemToOrderPricingOp
```
public void setAddItemToOrderPricingOp(java.lang.String pAddItemToOrderPricingOp)
```
    This property should be set to the type of pricing operation that should be executed when an item is added to the order. The operations which are acceptable are defined in the atg.commerce.pricing.PricingConstants interface. They include:
    - PricingConstants.OP_REPRICE_ORDER_TOTAL -> ORDER_TOTAL
    - PricingConstants.OP_REPRICE_ORDER_SUBTOTAL -> ORDER_SUBTOTAL
    - PricingConstants.OP_REPRICE_ORDER_SUBTOTAL_SHIPPING -> ORDER_SUBTOTAL_SHIPPING
    - PricingConstants.OP_REPRICE_ORDER_SUBTOTAL_TAX -> ORDER_SUBTOTAL_TAX
    - PricingConstants.OP_REPRICE_ITEMS -> ITEMS
    - PricingConstants.OP_REPRICE_SHIPPING -> SHIPPING
    - PricingConstants.OP_REPRICE_ORDER -> ORDER
    - PricingConstants.OP_REPRICE_TAX -> TAX
    - PricingConstants.OP_NO_REPRICE -> NO_REPRICE
    If this value is null, then the system will default to ORDER_TOTAL.
  - getAddItemToOrderPricingOp
```
public java.lang.String getAddItemToOrderPricingOp()
```
    Returns the pricing operation that should be performed when an item is added to the order
  - setModifyOrderPricingOp
```
public void setModifyOrderPricingOp(java.lang.String pModifyOrderPricingOp)
```
    This property should be set to the type of pricing operation that should be executed when the order is updated without adding or removing an item (e.g. quantity change). The operations which are acceptable are defined in the atg.commerce.pricing.PricingConstants interface. They include:
    - PricingConstants.OP_REPRICE_ORDER_TOTAL -> ORDER_TOTAL
    - PricingConstants.OP_REPRICE_ORDER_SUBTOTAL -> ORDER_SUBTOTAL
    - PricingConstants.OP_REPRICE_ORDER_SUBTOTAL_SHIPPING -> ORDER_SUBTOTAL_SHIPPING
    - PricingConstants.OP_REPRICE_ORDER_SUBTOTAL_TAX -> ORDER_SUBTOTAL_TAX
    - PricingConstants.OP_REPRICE_ITEMS -> ITEMS
    - PricingConstants.OP_REPRICE_SHIPPING -> SHIPPING
    - PricingConstants.OP_REPRICE_ORDER -> ORDER
    - PricingConstants.OP_REPRICE_TAX -> TAX
    - PricingConstants.OP_NO_REPRICE -> NO_REPRICE
    If this value is null, then the system will default to ORDER_TOTAL.
  - getModifyOrderPricingOp
```
public java.lang.String getModifyOrderPricingOp()
```
    Returns the pricing operation that should be performed when the order is updated
  - setDeleteItemsFromOrderPricingOp
```
public void setDeleteItemsFromOrderPricingOp(java.lang.String pDeleteItemsFromOrderPricingOp)
```
    This property should be set to the type of pricing operation that should be executed when an item is deleted from the order. The operations which are acceptable are defined in the atg.commerce.pricing.PricingConstants interface. They include:
    - PricingConstants.OP_REPRICE_ORDER_TOTAL -> ORDER_TOTAL
    - PricingConstants.OP_REPRICE_ORDER_SUBTOTAL -> ORDER_SUBTOTAL
    - PricingConstants.OP_REPRICE_ORDER_SUBTOTAL_SHIPPING -> ORDER_SUBTOTAL_SHIPPING
    - PricingConstants.OP_REPRICE_ORDER_SUBTOTAL_TAX -> ORDER_SUBTOTAL_TAX
    - PricingConstants.OP_REPRICE_ITEMS -> ITEMS
    - PricingConstants.OP_REPRICE_SHIPPING -> SHIPPING
    - PricingConstants.OP_REPRICE_ORDER -> ORDER
    - PricingConstants.OP_REPRICE_TAX -> TAX
    - PricingConstants.OP_NO_REPRICE -> NO_REPRICE
    If this value is null, then the system will default to ORDER_TOTAL.
  - getDeleteItemsFromOrderPricingOp
```
public java.lang.String getDeleteItemsFromOrderPricingOp()
```
    Returns the pricing operation that should be performed when an item is deleted from the order
  - setLocalLockManager
```
public void setLocalLockManager(ClientLockManager pLocalLockManager)
```
    Specify the lock manager to use if useLocksAroundTransactions is true in OrderModifierFormHandler and its subclasses.
    
    See Also:
    OrderModifierFormHandler.setUseLocksAroundTransactions(boolean)
  - getLocalLockManager
```
public ClientLockManager getLocalLockManager()
```
    Return the lock manager to use if useLocksAroundTransactions is true in OrderModifierFormHandler and its subclasses.
    
    See Also:
    OrderModifierFormHandler.setUseLocksAroundTransactions(boolean)

Class ShoppingCartModifierConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

Constructor Detail

ShoppingCartModifierConfiguration

Method Detail

setTransactionManager

getTransactionManager

setGiftlistManager

getGiftlistManager

setUserPricingModels

getUserPricingModels

setShoppingCart

getShoppingCart

setPipelineManager

getPipelineManager

setAddItemToOrderChainId

getAddItemToOrderChainId

setMoveToPurchaseInfoChainId

getMoveToPurchaseInfoChainId

setMoveToConfirmationChainId

getMoveToConfirmationChainId

setSetOrderChainId

getSetOrderChainId

setRepriceOrderChainId

getRepriceOrderChainId

setValidateShippingGroupsChainId

getValidateShippingGroupsChainId

setProfile

getProfile

setOrderManager

getOrderManager

setCatalogTools

getCatalogTools

setDefaultLocale

getDefaultLocale

setClaimableManager

getClaimableManager

setClaimableTools

getClaimableTools

setCommerceProfileTools

getCommerceProfileTools

setPropertyManager

getPropertyManager

setSoftGoodShippingGroupName

getSoftGoodShippingGroupName

setRepriceOrder

getRepriceOrder

setAddItemToOrderPricingOp

getAddItemToOrderPricingOp

setModifyOrderPricingOp

getModifyOrderPricingOp

setDeleteItemsFromOrderPricingOp

getDeleteItemsFromOrderPricingOp

setLocalLockManager

getLocalLockManager