atg.commerce.order.purchase
Class PurchaseProcessConfiguration

java.lang.Object
  atg.commerce.order.purchase.PurchaseProcessConfiguration

public class PurchaseProcessConfiguration
extends java.lang.Object

This class is designed to be configured as a session scoped component which stores configuration parameters for the family of PurchaseProcessFormHandler subclasses. Each form handler can be configured directly, however there are a large number of configuration properties to be set. In addition to the convenience of centralizing common properties in a single location, there is also a slight performance benefit. Since, typically, any 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

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

PurchaseProcessConfiguration()
Constructor

Method Summary

ClaimableManager	getClaimableManager() Returns the ClaimableManager is used in determining the user's GiftCertificates.
CommerceIdentifierPaymentInfoContainer	getCommerceIdentifierPaymentInfoContainer() Return the CommerceIdentifierPaymentInfoContainer property.
CommerceItemManager	getCommerceItemManager() Return the CommerceItemManager property.
CommerceItemShippingInfoContainer	getCommerceItemShippingInfoContainer() Return the CommerceItemShippingInfoContainer property.
CommerceProfileTools	getCommerceProfileTools() Returns property CommerceProfileTools
CommercePropertyManager	getCommercePropertyManager() Return the CommercePropertyManager property.
GiftlistManager	getGiftlistManager() Return the giftlist manager
HandlingInstructionManager	getHandlingInstructionManager() The HandlingInstruction manager
ClientLockManager	getLocalLockManager() Return the lock manager to use if useLocksAroundTransactions is true in PurchaseProcessFormHandler subclasses.
SimpleOrderManager	getOrderManager() Returns property OrderManager
PaymentGroupManager	getPaymentGroupManager() Return the PaymentGroupManager property.
PaymentGroupMapContainer	getPaymentGroupMapContainer() Return the PaymentGroupMapContainer property.
PipelineManager	getPipelineManager() Returns property PipelineManager
PriceListManager	getPriceListManager() Returns the Price List Manager
RepositoryItem	getProfile() Returns property Profile
Repository	getProfileRepository() Return the ProfileRepository property.
PurchaseProcessHelper	getPurchaseProcessHelper() Returns property purchaseProcessHelper
RepeatingRequestMonitor	getRepeatingRequestMonitor() Return the RepeatingRequestMonitor property.
java.lang.String	getRepriceOrderChainId() Returns property RepriceOrderChainId
java.lang.String	getSessionExpirationURL() Return the SessionExpirationURL property.
ShippingGroupManager	getShippingGroupManager() Return the ShippingGroupManager property.
ShippingGroupMapContainer	getShippingGroupMapContainer() Return the ShippingGroupMapContainer property.
OrderHolder	getShoppingCart() Returns property ShoppingCart
TransactionLockFactory	getTransactionLockFactory() The transactionLockFactory is used to get the locks if useLocksArountTransactions is true
javax.transaction.TransactionManager	getTransactionManager() Returns property TransactionManager
PricingModelHolder	getUserPricingModels() Returns property UserPricingModels
boolean	isEnsureTransaction() Returns property EnsureTransaction
boolean	isUseLocksAroundTransactionExplicitlySet() This will return true if the value of useLocksAroundTransaction has been explicitly set either through code or through a properties file.
boolean	isUseLocksAroundTransactions() Deprecated. Use the TransactionLockFactory instead
void	setClaimableManager(ClaimableManager pClaimableManager) Specifies the ClaimableManager to use in determining the user's GiftCertificates.
void	setCommerceIdentifierPaymentInfoContainer(CommerceIdentifierPaymentInfoContainer pCommerceIdentifierPaymentInfoContainer) Set the CommerceIdentifierPaymentInfoContainer property.
void	setCommerceItemManager(CommerceItemManager pCommerceItemManager) Set the CommerceItemManager property.
void	setCommerceItemShippingInfoContainer(CommerceItemShippingInfoContainer pCommerceItemShippingInfoContainer) Set the CommerceItemShippingInfoContainer property.
void	setCommerceProfileTools(CommerceProfileTools pCommerceProfileTools) Sets property CommerceProfileTools
void	setCommercePropertyManager(CommercePropertyManager pCommercePropertyManager) Set the CommercePropertyManager property.
void	setEnsureTransaction(boolean pEnsureTransaction) Sets property EnsureTransaction
void	setGiftlistManager(GiftlistManager pGiftlistManager) Set the giftlist manager
void	setHandlingInstructionManager(HandlingInstructionManager pHandlingInstructionManager) Specifies the HandlingInstructionManager.
void	setLocalLockManager(ClientLockManager pLocalLockManager) Specify the lock manager to use if useLocksAroundTransactions is true in PurchaseProcessFormHandler subclasses.
void	setOrderManager(SimpleOrderManager pOrderManager) Sets property OrderManager
void	setPaymentGroupManager(PaymentGroupManager pPaymentGroupManager) Set the PaymentGroupManager property.
void	setPaymentGroupMapContainer(PaymentGroupMapContainer pPaymentGroupMapContainer) Set the PaymentGroupMapContainer property.
void	setPipelineManager(PipelineManager pPipelineManager) Sets property PipelineManager
void	setPriceListManager(PriceListManager pPriceListManager) Sets the Price List Manager
void	setProfile(RepositoryItem pProfile) Sets property Profile
void	setProfileRepository(Repository pProfileRepository) Set the ProfileRepository property.
void	setPurchaseProcessHelper(PurchaseProcessHelper pPurchaseProcessHelper) Sets property purchaseProcessHelper
void	setRepeatingRequestMonitor(RepeatingRequestMonitor pRepeatingRequestMonitor) Set the RepeatingRequestMonitor property.
void	setRepriceOrderChainId(java.lang.String pRepriceOrderChainId) Sets property RepriceOrderChainId
void	setSessionExpirationURL(java.lang.String pSessionExpirationURL) Set the SessionExpirationURL property.
void	setShippingGroupManager(ShippingGroupManager pShippingGroupManager) Set the ShippingGroupManager property.
void	setShippingGroupMapContainer(ShippingGroupMapContainer pShippingGroupMapContainer) Set the ShippingGroupMapContainer property.
void	setShoppingCart(OrderHolder pShoppingCart) Sets property ShoppingCart
void	setTransactionLockFactory(TransactionLockFactory pTransactionLockFactory) The transactionLockFactory is used to get the locks if useLocksArountTransactions is true
void	setTransactionManager(javax.transaction.TransactionManager pTransactionManager) Sets property TransactionManager
void	setUseLocksAroundTransactions(boolean pUseLocksAroundTransactions) Deprecated. Use the TransactionLockFactory instead
void	setUserPricingModels(PricingModelHolder pUserPricingModels) Sets property UserPricingModels

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

PurchaseProcessConfiguration

public PurchaseProcessConfiguration()

Constructor

Method Detail

setCommercePropertyManager

public void setCommercePropertyManager(CommercePropertyManager pCommercePropertyManager)

Set the CommercePropertyManager property.

Parameters:

pCommercePropertyManager - the Commerce profile property manager

getCommercePropertyManager

public CommercePropertyManager getCommercePropertyManager()

Return the CommercePropertyManager property.

setPriceListManager

public void setPriceListManager(PriceListManager pPriceListManager)

Sets the Price List Manager

Parameters:

pPriceListManager - the Price List Manager

getPriceListManager

public PriceListManager getPriceListManager()

Returns the Price List Manager

setClaimableManager

public void setClaimableManager(ClaimableManager pClaimableManager)

Specifies the ClaimableManager to use in determining the user's GiftCertificates.

Parameters:

pClaimableManager - a ClaimableManager value

getClaimableManager

public ClaimableManager getClaimableManager()

Returns the ClaimableManager is used in determining the user's GiftCertificates.

Returns:

a ClaimableManager value

setCommerceIdentifierPaymentInfoContainer

public void setCommerceIdentifierPaymentInfoContainer(CommerceIdentifierPaymentInfoContainer pCommerceIdentifierPaymentInfoContainer)

Set the CommerceIdentifierPaymentInfoContainer property.

Parameters:

pCommerceIdentifierPaymentInfoContainer - a CommerceIdentifierPaymentInfoContainer value

getCommerceIdentifierPaymentInfoContainer

public CommerceIdentifierPaymentInfoContainer getCommerceIdentifierPaymentInfoContainer()

Return the CommerceIdentifierPaymentInfoContainer property.

Returns:

a CommerceIdentifierPaymentInfoContainer value

setCommerceItemManager

public void setCommerceItemManager(CommerceItemManager pCommerceItemManager)

Set the CommerceItemManager property.

Parameters:

pCommerceItemManager - a CommerceItemManager value

getCommerceItemManager

public CommerceItemManager getCommerceItemManager()

Return the CommerceItemManager property.

Returns:

a CommerceItemManager value

setCommerceItemShippingInfoContainer

public void setCommerceItemShippingInfoContainer(CommerceItemShippingInfoContainer pCommerceItemShippingInfoContainer)

Set the CommerceItemShippingInfoContainer property.

Parameters:

pCommerceItemShippingInfoContainer - a CommerceItemShippingInfoContainer value

getCommerceItemShippingInfoContainer

public CommerceItemShippingInfoContainer getCommerceItemShippingInfoContainer()

Return the CommerceItemShippingInfoContainer property.

Returns:

a CommerceItemShippingInfoContainer value

setCommerceProfileTools

public void setCommerceProfileTools(CommerceProfileTools pCommerceProfileTools)

Sets property CommerceProfileTools

getCommerceProfileTools

public CommerceProfileTools getCommerceProfileTools()

Returns property CommerceProfileTools

setEnsureTransaction

public void setEnsureTransaction(boolean pEnsureTransaction)

Sets property EnsureTransaction

Parameters:

pEnsureTransaction - a boolean value

isEnsureTransaction

public boolean isEnsureTransaction()

Returns property EnsureTransaction

Returns:

a boolean value

setGiftlistManager

public void setGiftlistManager(GiftlistManager pGiftlistManager)

Set the giftlist manager

getGiftlistManager

public GiftlistManager getGiftlistManager()

Return the giftlist manager

setHandlingInstructionManager

public void setHandlingInstructionManager(HandlingInstructionManager pHandlingInstructionManager)

Specifies the HandlingInstructionManager.

Parameters:

pHandlingInstructionManager - a HandlingInstructionManager value

getHandlingInstructionManager

public HandlingInstructionManager getHandlingInstructionManager()

The HandlingInstruction manager

Returns:

a HandlingInstructionManager value

setLocalLockManager

public void setLocalLockManager(ClientLockManager pLocalLockManager)

Specify the lock manager to use if useLocksAroundTransactions is true in PurchaseProcessFormHandler subclasses.

See Also:

PurchaseProcessFormHandler.setUseLocksAroundTransactions(boolean)

getLocalLockManager

public ClientLockManager getLocalLockManager()

Return the lock manager to use if useLocksAroundTransactions is true in PurchaseProcessFormHandler subclasses.

See Also:

PurchaseProcessFormHandler.setUseLocksAroundTransactions(boolean)

setOrderManager

public void setOrderManager(SimpleOrderManager pOrderManager)

Sets property OrderManager

getOrderManager

public SimpleOrderManager getOrderManager()

Returns property OrderManager

setPaymentGroupManager

public void setPaymentGroupManager(PaymentGroupManager pPaymentGroupManager)

Set the PaymentGroupManager property.

Parameters:

pPaymentGroupManager - a PaymentGroupManager value

getPaymentGroupManager

public PaymentGroupManager getPaymentGroupManager()

Return the PaymentGroupManager property.

Returns:

a PaymentGroupManager value

setPaymentGroupMapContainer

public void setPaymentGroupMapContainer(PaymentGroupMapContainer pPaymentGroupMapContainer)

Set the PaymentGroupMapContainer property.

Parameters:

pPaymentGroupMapContainer - a PaymentGroupMapContainer value

getPaymentGroupMapContainer

public PaymentGroupMapContainer getPaymentGroupMapContainer()

Return the PaymentGroupMapContainer property.

Returns:

a PaymentGroupMapContainer value

setPipelineManager

public void setPipelineManager(PipelineManager pPipelineManager)

Sets property PipelineManager

getPipelineManager

public PipelineManager getPipelineManager()

Returns property PipelineManager

setProfile

public void setProfile(RepositoryItem pProfile)

Sets property Profile

getProfile

public RepositoryItem getProfile()

Returns property Profile

setProfileRepository

public void setProfileRepository(Repository pProfileRepository)

Set the ProfileRepository property.

Parameters:

pProfileRepository - a Repository value

getProfileRepository

public Repository getProfileRepository()

Return the ProfileRepository property.

Returns:

a Repository value

setRepeatingRequestMonitor

public void setRepeatingRequestMonitor(RepeatingRequestMonitor pRepeatingRequestMonitor)

Set the RepeatingRequestMonitor property.

Parameters:

pRepeatingRequestMonitor - a RepeatingRequestMonitor value

getRepeatingRequestMonitor

public RepeatingRequestMonitor getRepeatingRequestMonitor()

Return the RepeatingRequestMonitor property.

Returns:

a RepeatingRequestMonitor value

setRepriceOrderChainId

public void setRepriceOrderChainId(java.lang.String pRepriceOrderChainId)

Sets property RepriceOrderChainId

getRepriceOrderChainId

public java.lang.String getRepriceOrderChainId()

Returns property RepriceOrderChainId

setSessionExpirationURL

public void setSessionExpirationURL(java.lang.String pSessionExpirationURL)

Set the SessionExpirationURL property.

Parameters:

pSessionExpirationURL - a String value

getSessionExpirationURL

public java.lang.String getSessionExpirationURL()

Return the SessionExpirationURL property.

Returns:

a String value

setShippingGroupManager

public void setShippingGroupManager(ShippingGroupManager pShippingGroupManager)

Set the ShippingGroupManager property.

Parameters:

pShippingGroupManager - a ShippingGroupManager value

getShippingGroupManager

public ShippingGroupManager getShippingGroupManager()

Return the ShippingGroupManager property.

Returns:

a ShippingGroupManager value

setShippingGroupMapContainer

public void setShippingGroupMapContainer(ShippingGroupMapContainer pShippingGroupMapContainer)

Set the ShippingGroupMapContainer property.

Parameters:

pShippingGroupMapContainer - a ShippingGroupMapContainer value

getShippingGroupMapContainer

public ShippingGroupMapContainer getShippingGroupMapContainer()

Return the ShippingGroupMapContainer property.

Returns:

a ShippingGroupMapContainer value

setShoppingCart

public void setShoppingCart(OrderHolder pShoppingCart)

Sets property ShoppingCart

getShoppingCart

public OrderHolder getShoppingCart()

Returns property ShoppingCart

setTransactionLockFactory

public void setTransactionLockFactory(TransactionLockFactory pTransactionLockFactory)

The transactionLockFactory is used to get the locks if useLocksArountTransactions is true

getTransactionLockFactory

public TransactionLockFactory getTransactionLockFactory()

The transactionLockFactory is used to get the locks if useLocksArountTransactions is true

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

Sets property TransactionManager

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

Returns property TransactionManager

setUseLocksAroundTransactions

public void setUseLocksAroundTransactions(boolean pUseLocksAroundTransactions)

Deprecated. Use the TransactionLockFactory instead

Specify whether to use a local lock manager to obtain a lock before starting transactions in beforeSet and to release the lock after committing transacations in afterSet.

If this property is set to true, locking will be used to prevent one user from trying to modify orders in multiple concurrent threads. This has a small performance impact as we obtain and release the lock, but minimizes the possibility of concurrent update exceptions if two threads try to modify the same order for the same user. The default value for useLocksAroundTransactions is true.

isUseLocksAroundTransactions

public boolean isUseLocksAroundTransactions()

Deprecated. Use the TransactionLockFactory instead

Inquire whether to use a local lock manager to obtain a lock before starting transactions in beforeSet, and to release the lock after committing transactions in afterSet.

isUseLocksAroundTransactionExplicitlySet

public boolean isUseLocksAroundTransactionExplicitlySet()

This will return true if the value of useLocksAroundTransaction has been explicitly set either through code or through a properties file.

setUserPricingModels

public void setUserPricingModels(PricingModelHolder pUserPricingModels)

Sets property UserPricingModels

getUserPricingModels

public PricingModelHolder getUserPricingModels()

Returns property UserPricingModels

setPurchaseProcessHelper

public void setPurchaseProcessHelper(PurchaseProcessHelper pPurchaseProcessHelper)

Sets property purchaseProcessHelper

getPurchaseProcessHelper

public PurchaseProcessHelper getPurchaseProcessHelper()

Returns property purchaseProcessHelper