public class CSREnvironmentTools
extends atg.nucleus.GenericService
CSREnvironmentConstants
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CATALOG_TREE_STATE_PATH
The path to the environment's tree state component
|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
CSR_APP_NAME
Commerce Application name
|
static java.lang.String |
CSR_ENVIRONMENTTOOLS_PATH
The path to the CSREnvironmentTools component
|
static java.lang.String |
EXCHANGE_PRICING_MODEL_PATH
The path to the pricing model component used for pricing exchange orders
|
protected atg.commerce.catalog.CatalogTools |
mCatalogTools |
protected atg.commerce.order.purchase.CommerceItemShippingInfoTools |
mCommerceItemShippingInfoTools |
protected CSRAgentTools |
mCSRAgentTools |
protected java.lang.String |
mCSRApplicationName |
protected CSRScheduledOrderTools |
mCSRScheduledOrderTools |
protected atg.svc.agent.environment.EnvironmentTools |
mEnvironmentTools |
protected static CSREnvironmentTools |
mGlobalEnvironmentTools |
protected atg.web.messaging.MessageTools |
mMessageTools |
protected atg.commerce.pricing.priceLists.PriceListManager |
mPriceListManager |
protected atg.multisite.SiteGroupManager |
mSiteGroupManager |
protected static java.lang.String |
MY_RESOURCES
resource bundle used to generate user localized messages
|
protected static java.lang.String |
MY_SERVER_RESOURCES
resource bundle used to generate server localized messages
|
static java.lang.String |
ORDER_HOLDER_PATH
The path to the environment's order holder component
|
static java.lang.String |
PRICING_MODEL_PATH
The path to the environment's pricing model component
|
static java.lang.String |
PROMOTION_WALLET_PRICING_MODEL_PATH
The path to the environment's promotion wallet component
|
static java.lang.String |
PURCHASE_PROCESS_CONFIGURATION_PATH
The path to the purchase process configuration component
|
static java.lang.String |
SUBMITTED_ORDER_PRICING_MODEL_PATH
The path to the environment's submitted order pricing model component
|
static java.lang.String |
VIEW_ORDER_HOLDER_PATH
The path to the environment's view order holder component
|
Constructor and Description |
---|
CSREnvironmentTools() |
Modifier and Type | Method and Description |
---|---|
protected void |
addChangeCatalogDetail(atg.repository.RepositoryItem pCatalog,
atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Adds a change detail for the given custom catalog.
|
void |
addChangeCatalogDetail(java.lang.String pCatalogId,
atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Adds a change detail for a change in catalog
|
void |
addChangeOrderDetail(atg.commerce.order.Order pOrder,
atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Adds a change order detail for loading an existing order.
|
void |
addChangeOrderDetail(java.lang.String pOrderId,
atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Adds a change order detail for loading an existing order.
|
void |
addChangePriceListDetail(atg.repository.RepositoryItem pPriceList,
atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Adds a change detail for the given price list.
|
void |
addChangePriceListDetail(java.lang.String pPriceListId,
atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Adds a change detail for the price list with the given id.
|
void |
addChangeSalePriceListDetail(atg.repository.RepositoryItem pPriceList,
atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Adds a change detail for the given sale price list.
|
void |
addChangeSalePriceListDetail(java.lang.String pPriceListId,
atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Adds a change detail for the sale price list with the given id.
|
void |
addNewOrderDetail(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Adds a change environment detail for a new order.
|
void |
changeOrder(java.lang.String pApplicationName,
atg.commerce.order.Order pOrder,
atg.svc.agent.environment.TicketDispositionOptions pTicketDispositionOptions)
Changes the environment's current order to the given order
|
void |
changeOrder(java.lang.String pApplicationName,
java.lang.String pOrderId,
atg.svc.agent.environment.TicketDispositionOptions pTicketDispositionOptions)
Changes the environment's current order to the given order
|
void |
changeViewOrder(java.lang.String pViewOrderId)
This method will change the current view order to the given order.
|
void |
cleanCatalogTreeState(atg.web.tree.TreeState treeState)
Nulls properties of catalog navigation tree
|
void |
cleanPaymentGroupContainerService()
When the environment changes are applied, there could be stale data in the
PaymentGroupMapContainer . |
void |
createNewOrder(java.lang.String pApplicationName)
Creates a new order in the order holder.
|
java.util.List |
createWarningsForCatalogSwitch(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Generates warnings for a change of catalog
|
java.util.List |
createWarningsForChangeOrder(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Generates warnings for a change of order
|
protected java.util.List |
createWarningsForCurrentOrder()
Adds a warning for the current order if there are pending changes(to a submitted order) or
if it's an unsaved new order with items in it.
|
protected java.util.Collection |
createWarningsForItemRemoves(atg.commerce.order.Order pOrder,
java.util.Collection pRemoveItems)
Creates a warning message for each item in the
pRemoveItems collection. |
protected java.util.List |
createWarningsForNewOrder(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Create warnings for the order that will be loaded for the change.
|
java.util.List |
createWarningsForPriceListSwitch(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Generates warnings for a change of price list
|
boolean |
deleteItemsWithoutPrice(atg.commerce.order.Order pOrder)
Deletes item from the order that cannot be priced by either the current
price list or sale price list.
|
boolean |
doSitesShare(java.lang.String pSiteId1,
java.lang.String pSiteId2)
This is just a convenient method to compare two cart sharing sites.
|
java.util.Collection |
findItemsNotInPriceList(java.util.Collection pCommerceItems,
atg.repository.RepositoryItem pPriceList)
Finds the commerce items in the collection that cannot be priced using the provided
price list.
|
java.util.Collection |
findItemsWithoutPrice(atg.commerce.order.Order pOrder,
atg.repository.RepositoryItem pListPriceList,
atg.repository.RepositoryItem pSalePriceList)
Returns commerce items in the order that cannot be using the given list price list
and sale price list.
|
atg.svc.agent.environment.EnvironmentChangeDetail |
getCatalogDetail(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
returns the catalog EnvironmentChangeDetail if there is one in the state already
|
atg.repository.RepositoryItem |
getCatalogFromCallState(java.lang.String pSiteId)
This method returns the site's catalog from the call state.
|
atg.commerce.catalog.CatalogTools |
getCatalogTools() |
atg.web.tree.TreeState |
getCatalogTreeState()
Returns the catalog tree state
|
atg.commerce.order.purchase.CommerceItemShippingInfoTools |
getCommerceItemShippingInfoTools()
Returns the commerceItemShippingInfoTools
|
CSRAgentTools |
getCSRAgentTools() |
java.lang.String |
getCSRApplicationName() |
CSRScheduledOrderTools |
getCSRScheduledOrderTools()
Returns a reference to the CSRScheduledOrderTools component
|
atg.repository.RepositoryItem |
getCurrentCatalog()
Returns the environment's current catalog.
|
CurrentCatalogHolder |
getCurrentCatalogHolder()
This method resolves the
CurrentCatalogHolder component and returns the same. |
atg.commerce.order.Order |
getCurrentOrder()
Returns the current order
|
atg.commerce.pricing.PricingModelHolder |
getCurrentOrderPricingModelHolder()
Returns the correct pricing model holder for the current order based on
its state.
|
atg.repository.RepositoryItem |
getCurrentPriceList()
Returns the environment's current price list.
|
atg.commerce.csr.returns.ReturnRequest |
getCurrentReturnRequest()
Returns the current ReturnRequest.
|
atg.repository.RepositoryItem |
getCurrentSalePriceList()
Returns the environment's current price list.
|
atg.commerce.pricing.PricingModelHolder |
getCustomerPricingModels()
Returns the customer pricing models
|
protected atg.repository.RepositoryItem |
getDefaultCatalog()
Returns the default catalog from configuration.
|
atg.svc.agent.environment.EnvironmentTools |
getEnvironmentTools() |
atg.commerce.pricing.PricingModelHolder |
getExchangePricingModels()
Returns the pricing model holder used for pricing the exchange order
during a return.
|
static CSREnvironmentTools |
getInstance()
Returns the global CSREnvironmentTools component by resolving it from the current
request.
|
atg.repository.RepositoryItem |
getListPriceListFromOrder(atg.commerce.order.Order pOrder)
Returns the list price list from the order.
|
atg.web.messaging.MessageTools |
getMessageTools()
Returns the MessageTools component
|
java.lang.String |
getOrderChangeId(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Convenience method for returning the
order id of the order that will be loaded as part of the change.
|
atg.svc.agent.environment.EnvironmentChangeDetail |
getOrderDetail(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
returns the order EnvironmentChangeDetail if there is one in the state already
|
CSROrderHolder |
getOrderHolder()
Returns the current order holder
|
atg.commerce.pricing.PricingModelHolder |
getOrderPricingModelHolder(atg.commerce.order.Order pOrder)
Returns either the standard customer pricing model holder or the submitted
order pricing model holder based on the state of the given order.
|
atg.commerce.order.Order |
getOriginalOrder()
This method returns the original order if the holder is in clone
edit mode.
|
atg.commerce.order.Order |
getOriginalOrder(atg.commerce.order.Order pOrder)
If the given order is current in the cart and the cart is in clone edit mode,
the original order is returned.
|
atg.svc.agent.environment.EnvironmentChangeDetail |
getPriceListDetail(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
returns the price list EnvironmentChangeDetail if there is one in the state already
|
atg.repository.RepositoryItem |
getPriceListFromOrder(atg.commerce.order.Order pOrder)
Returns the price list from the order.
|
atg.commerce.pricing.priceLists.PriceListManager |
getPriceListManager() |
atg.commerce.pricing.PricingModelHolder |
getPromotionWalletPricingModels()
Returns the promotion wallet pricing models
|
atg.commerce.order.purchase.PurchaseProcessConfiguration |
getPurchaseProcessConfiguration()
Returns the purchase process configuration
|
atg.svc.agent.environment.EnvironmentChangeDetail |
getSalePriceListDetail(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
returns the sale price list EnvironmentChangeDetail if there is one in the state already
|
atg.repository.RepositoryItem |
getSalePriceListFromOrder(atg.commerce.order.Order pOrder)
Returns the sale price list from the order.
|
java.lang.String |
getServerResource(java.lang.String pKey,
java.lang.Object[] pMsgArgs)
Returns a resource from the server localized resource bundle
|
atg.multisite.SiteGroupManager |
getSiteGroupManager()
Returns the siteGroupManager
|
SubmittedOrderPricingModelHolder |
getSubmittedOrderPricingModels()
Returns the pricing model holder used for submitted orders
|
java.util.Locale |
getUserLocale()
This method gets the current Locale
|
java.lang.String |
getUserResource(java.lang.String pKey,
java.lang.Object[] pMsgArgs,
java.util.Locale pLocale)
Returns a resource from the user resource bundle
|
atg.repository.RepositoryItem |
getUsersCatalog(atg.repository.RepositoryItem pProfile,
atg.multisite.Site pSite)
Returns a catalog.
|
atg.commerce.order.Order |
getViewOrder()
Returns the view current order
|
ViewOrderHolder |
getViewOrderHolder()
Returns the current view order holder
|
void |
initializeCustomerPricingModels()
Initializes the customer pricing models
|
void |
initializeDefaultsForProfile(atg.repository.MutableRepositoryItem pProfile)
Set the default values for a new profile.
|
protected void |
initializeShippingGroupContainerService(atg.userprofiling.Profile pProfile,
atg.commerce.order.Order pOrder)
This method is used to initialize
ShippingGroupMapContainerService . |
void |
invalidateViewOrder()
This method will invalidate the order in the view order holder.
|
boolean |
isActiveOrderOwnerChangeble()
Determines if the active order may have a new owner assigned.
|
boolean |
isActiveOrderUpdatedSinceLoad()
Returns true if the orders last modification time is greater than
the CSROrderHolder's loadTime.
|
boolean |
isCatalogExplicitlySetForCall()
This method gets the current site in the environment using
EnvironmentTools.getCurrentSite() and
calls isCatalogExplicitlySetForCall(Site) . |
boolean |
isCatalogExplicitlySetForCall(atg.multisite.Site pSite)
Determines if the catalog has been explicitly set by the agent for the current call.
|
boolean |
isNewOrderDetail(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
Determines if a EnvironmentChangeDetail exists for a new order change.
|
protected boolean |
isOwnerChangeable(atg.commerce.order.Order pOrder,
atg.repository.RepositoryItem pNewOwnerProfile)
Determines if an order may have the new owner assigned.
|
boolean |
isPriceListExplicitlySetForCall()
Determines if the price list has been explicitly set by the agent for the current call.
|
boolean |
isReturnExchange()
Returns true is the agent is currently working on a return or exchange
|
boolean |
isSalePriceListExplicitlySetForCall()
Determines if the sale price list has been explicitly set by the agent for the current call.
|
boolean |
isSiteValidForEnvironment(atg.repository.RepositoryItem pSite)
This method decides whether the site is valid for the environment or not.
|
boolean |
isSiteValidForEnvironment(java.lang.String pSiteId)
This method decides whether the site is valid for the environment or not.
|
void |
loadViewOrderAndProfile(atg.commerce.order.Order pOrder)
Loads the given order into the view order holder and the order's owner into
the view profile holder.
|
void |
setCatalogTools(atg.commerce.catalog.CatalogTools pCatalogTools)
Sets the catalog tools component
|
void |
setCommerceItemShippingInfoTools(atg.commerce.order.purchase.CommerceItemShippingInfoTools pCommerceItemShippingInfoTools)
Sets the commerceItemShippingInfoTools
|
void |
setCSRAgentTools(CSRAgentTools pCSRAgentTools)
Sets the property CSRAgentTools.
|
void |
setCSRApplicationName(java.lang.String pCSRApplicationName) |
void |
setCSRScheduledOrderTools(CSRScheduledOrderTools pCSRScheduledOrderTools) |
void |
setCurrentCatalog(atg.repository.RepositoryItem pCatalog)
Sets the current catalog in global context by issuing an
environment change request.
|
void |
setCurrentPriceList(atg.repository.RepositoryItem pPriceList)
Sets the current price list in global context by issuing an
environment change request.
|
void |
setCurrentSalePriceList(atg.repository.RepositoryItem pPriceList)
Sets the current sale price list in global context by issuing an
environment change request.
|
void |
setEnvironmentTools(atg.svc.agent.environment.EnvironmentTools pEnvironmentTools)
Sets the EnvironmentTools
|
void |
setMessageTools(atg.web.messaging.MessageTools pMessageTools) |
void |
setPriceListManager(atg.commerce.pricing.priceLists.PriceListManager pPriceListManager)
Sets the Price List Manager
|
void |
setSiteGroupManager(atg.multisite.SiteGroupManager pSiteGroupManager)
Sets the siteGroupManager
|
void |
setViewOrder(atg.commerce.order.Order pViewOrder)
Sets the view order as the the current view order in the Environment
|
protected boolean |
shouldInitializePricingModelHolder(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
This method decides whether the pricing model holder needs to be initialized based on the changes
being made to the environment.
|
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static final java.lang.String CSR_APP_NAME
public static final java.lang.String CSR_ENVIRONMENTTOOLS_PATH
public static final java.lang.String ORDER_HOLDER_PATH
public static final java.lang.String VIEW_ORDER_HOLDER_PATH
public static final java.lang.String PRICING_MODEL_PATH
public static final java.lang.String SUBMITTED_ORDER_PRICING_MODEL_PATH
public static final java.lang.String CATALOG_TREE_STATE_PATH
public static final java.lang.String EXCHANGE_PRICING_MODEL_PATH
public static final java.lang.String PROMOTION_WALLET_PRICING_MODEL_PATH
public static final java.lang.String PURCHASE_PROCESS_CONFIGURATION_PATH
protected static final java.lang.String MY_RESOURCES
protected static final java.lang.String MY_SERVER_RESOURCES
protected static CSREnvironmentTools mGlobalEnvironmentTools
protected java.lang.String mCSRApplicationName
protected atg.svc.agent.environment.EnvironmentTools mEnvironmentTools
protected atg.commerce.pricing.priceLists.PriceListManager mPriceListManager
protected atg.commerce.catalog.CatalogTools mCatalogTools
protected CSRAgentTools mCSRAgentTools
protected CSRScheduledOrderTools mCSRScheduledOrderTools
protected atg.multisite.SiteGroupManager mSiteGroupManager
protected atg.commerce.order.purchase.CommerceItemShippingInfoTools mCommerceItemShippingInfoTools
protected atg.web.messaging.MessageTools mMessageTools
public java.util.Locale getUserLocale()
EnvironmentTools.getUserLocale()
public static CSREnvironmentTools getInstance()
public java.lang.String getCSRApplicationName()
public void setCSRApplicationName(java.lang.String pCSRApplicationName)
public void setEnvironmentTools(atg.svc.agent.environment.EnvironmentTools pEnvironmentTools)
pEnvironmentTools
- the EnvironmentTools in Servicepublic atg.svc.agent.environment.EnvironmentTools getEnvironmentTools()
public void setPriceListManager(atg.commerce.pricing.priceLists.PriceListManager pPriceListManager)
pPriceListManager
- the Price List Managerpublic atg.commerce.pricing.priceLists.PriceListManager getPriceListManager()
public void setCatalogTools(atg.commerce.catalog.CatalogTools pCatalogTools)
pCatalogTools
- the catalog tools componentpublic atg.commerce.catalog.CatalogTools getCatalogTools()
public void setCSRAgentTools(CSRAgentTools pCSRAgentTools)
public CSRAgentTools getCSRAgentTools()
public CSRScheduledOrderTools getCSRScheduledOrderTools()
public void setCSRScheduledOrderTools(CSRScheduledOrderTools pCSRScheduledOrderTools)
public atg.multisite.SiteGroupManager getSiteGroupManager()
public void setSiteGroupManager(atg.multisite.SiteGroupManager pSiteGroupManager)
pSiteGroupManager
- the siteGroupManager to setpublic atg.commerce.order.purchase.CommerceItemShippingInfoTools getCommerceItemShippingInfoTools()
public void setCommerceItemShippingInfoTools(atg.commerce.order.purchase.CommerceItemShippingInfoTools pCommerceItemShippingInfoTools)
pCommerceItemShippingInfoTools
- the commerceItemShippingInfoTools to setpublic atg.web.messaging.MessageTools getMessageTools()
public void setMessageTools(atg.web.messaging.MessageTools pMessageTools)
public boolean isActiveOrderUpdatedSinceLoad()
public boolean isNewOrderDetail(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
pEnvironmentChangeState
- protected boolean isOwnerChangeable(atg.commerce.order.Order pOrder, atg.repository.RepositoryItem pNewOwnerProfile)
True is returned if the order is considered incomplete and not in a pending approval state.
pOrder
- the orderpNewOwnerProfile
- repository item representing the potential new owner of the order. This
can be null.public boolean isActiveOrderOwnerChangeble()
True is returned if the active order is incomplete and return process is not started.
public atg.svc.agent.environment.EnvironmentChangeDetail getOrderDetail(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
pEnvironmentChangeState
- public atg.svc.agent.environment.EnvironmentChangeDetail getPriceListDetail(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
pEnvironmentChangeState
- public atg.svc.agent.environment.EnvironmentChangeDetail getSalePriceListDetail(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
pEnvironmentChangeState
- public atg.svc.agent.environment.EnvironmentChangeDetail getCatalogDetail(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
pEnvironmentChangeState
- public java.lang.String getOrderChangeId(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
public void addNewOrderDetail(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState) throws atg.svc.agent.environment.EnvironmentChangeDetailConflict, atg.svc.agent.environment.EnvironmentException
pEnvironmentChangeState
- atg.svc.agent.environment.EnvironmentChangeDetailConflict
atg.svc.agent.environment.EnvironmentException
public void addChangeOrderDetail(java.lang.String pOrderId, atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState) throws atg.svc.agent.environment.EnvironmentChangeDetailConflict, atg.svc.agent.environment.EnvironmentException
pOrderId
- pEnvironmentChangeState
- atg.svc.agent.environment.EnvironmentChangeDetailConflict
atg.svc.agent.environment.EnvironmentException
public void addChangeOrderDetail(atg.commerce.order.Order pOrder, atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState) throws atg.svc.agent.environment.EnvironmentChangeDetailConflict, atg.svc.agent.environment.EnvironmentException
pOrder
- pEnvironmentChangeState
- atg.svc.agent.environment.EnvironmentChangeDetailConflict
atg.svc.agent.environment.EnvironmentException
public void addChangeCatalogDetail(java.lang.String pCatalogId, atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState) throws atg.svc.agent.environment.EnvironmentChangeDetailConflict, atg.svc.agent.environment.EnvironmentException
pCatalogId
- pEnvironmentChangeState
- atg.svc.agent.environment.EnvironmentChangeDetailConflict
atg.svc.agent.environment.EnvironmentException
public void addChangePriceListDetail(java.lang.String pPriceListId, atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState) throws atg.svc.agent.environment.EnvironmentChangeDetailConflict, atg.svc.agent.environment.EnvironmentException
pPriceListId
- pEnvironmentChangeState
- atg.svc.agent.environment.EnvironmentChangeDetailConflict
atg.svc.agent.environment.EnvironmentException
public void addChangePriceListDetail(atg.repository.RepositoryItem pPriceList, atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState) throws atg.svc.agent.environment.EnvironmentChangeDetailConflict, atg.svc.agent.environment.EnvironmentException
pPriceList
- pEnvironmentChangeState
- atg.svc.agent.environment.EnvironmentChangeDetailConflict
atg.svc.agent.environment.EnvironmentException
protected void addChangeCatalogDetail(atg.repository.RepositoryItem pCatalog, atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState) throws atg.svc.agent.environment.EnvironmentChangeDetailConflict, atg.svc.agent.environment.EnvironmentException
pCatalog
- pEnvironmentChangeState
- atg.svc.agent.environment.EnvironmentChangeDetailConflict
atg.svc.agent.environment.EnvironmentException
public void addChangeSalePriceListDetail(java.lang.String pPriceListId, atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState) throws atg.svc.agent.environment.EnvironmentChangeDetailConflict, atg.svc.agent.environment.EnvironmentException
pPriceListId
- pEnvironmentChangeState
- atg.svc.agent.environment.EnvironmentChangeDetailConflict
atg.svc.agent.environment.EnvironmentException
public void addChangeSalePriceListDetail(atg.repository.RepositoryItem pPriceList, atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState) throws atg.svc.agent.environment.EnvironmentChangeDetailConflict, atg.svc.agent.environment.EnvironmentException
pPriceList
- pEnvironmentChangeState
- atg.svc.agent.environment.EnvironmentChangeDetailConflict
atg.svc.agent.environment.EnvironmentException
public CSROrderHolder getOrderHolder()
public atg.commerce.order.Order getCurrentOrder()
public atg.commerce.csr.returns.ReturnRequest getCurrentReturnRequest()
public ViewOrderHolder getViewOrderHolder()
public atg.commerce.order.Order getViewOrder()
public void setViewOrder(atg.commerce.order.Order pViewOrder) throws atg.svc.agent.environment.EnvironmentException
pViewOrder
- atg.svc.agent.environment.EnvironmentException
public void invalidateViewOrder()
This method can be used in cases where the same order was updated and you want to reflect the updates in the view.
public atg.commerce.order.Order getOriginalOrder()
public atg.commerce.pricing.PricingModelHolder getCustomerPricingModels()
public atg.commerce.pricing.PricingModelHolder getPromotionWalletPricingModels()
public SubmittedOrderPricingModelHolder getSubmittedOrderPricingModels()
public atg.commerce.pricing.PricingModelHolder getExchangePricingModels()
public atg.web.tree.TreeState getCatalogTreeState()
public atg.commerce.order.purchase.PurchaseProcessConfiguration getPurchaseProcessConfiguration()
public atg.commerce.pricing.PricingModelHolder getCurrentOrderPricingModelHolder()
If the current order is incomplete the standard customer pricing model holder is returned. Otherwise, the submitted order pricing model holder is returned.
public atg.commerce.pricing.PricingModelHolder getOrderPricingModelHolder(atg.commerce.order.Order pOrder)
pOrder
- public atg.repository.RepositoryItem getCurrentPriceList()
public void setCurrentPriceList(atg.repository.RepositoryItem pPriceList)
pPriceList
- the new price list to be set in global contextpublic atg.repository.RepositoryItem getCurrentSalePriceList()
public void setCurrentSalePriceList(atg.repository.RepositoryItem pPriceList)
pPriceList
- the new sale price list to be set in global contextprotected atg.repository.RepositoryItem getDefaultCatalog() throws atg.svc.agent.environment.EnvironmentException
atg.svc.agent.environment.EnvironmentException
CSRConfigurator.getDefaultCatalogId()
public atg.repository.RepositoryItem getCurrentCatalog()
public void setCurrentCatalog(atg.repository.RepositoryItem pCatalog)
pCatalog
- the new catalog to be set in global contextpublic void initializeDefaultsForProfile(atg.repository.MutableRepositoryItem pProfile) throws atg.svc.agent.environment.EnvironmentException
Sends an initialization jms event to the application can apply their business rules to the process.
The caller is responsible for transaction demarcation and calling updateItem on the profile.
pProfile
- the profile item to initializeatg.svc.agent.environment.EnvironmentException
public atg.repository.RepositoryItem getPriceListFromOrder(atg.commerce.order.Order pOrder)
The price list from the first commerce item in the order is returned.
pOrder
- public atg.repository.RepositoryItem getListPriceListFromOrder(atg.commerce.order.Order pOrder)
The price list is found by looking for a commerce item that is not on sale with a price list associated.
pOrder
- PricingTools.getListPriceListFromOrder(Order)
public atg.repository.RepositoryItem getSalePriceListFromOrder(atg.commerce.order.Order pOrder)
The price list from the first on sale commerce item in the order is returned. with a price list associated.
pOrder
- PricingTools.getSalePriceListFromOrder(Order)
public java.util.List createWarningsForCatalogSwitch(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
public java.util.List createWarningsForPriceListSwitch(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
protected java.util.Collection createWarningsForItemRemoves(atg.commerce.order.Order pOrder, java.util.Collection pRemoveItems)
pRemoveItems
collection.pOrder
- pRemoveItems
- public java.util.Collection findItemsNotInPriceList(java.util.Collection pCommerceItems, atg.repository.RepositoryItem pPriceList)
pCommerceItems
- pPriceList
- public java.util.Collection findItemsWithoutPrice(atg.commerce.order.Order pOrder, atg.repository.RepositoryItem pListPriceList, atg.repository.RepositoryItem pSalePriceList)
pOrder
- pListPriceList
- the list price listpSalePriceList
- Optional sale price listpublic boolean deleteItemsWithoutPrice(atg.commerce.order.Order pOrder) throws atg.svc.agent.environment.EnvironmentException
The caller is responsible for transaction demarcation and calling updateOrder.
pOrder
- atg.svc.agent.environment.EnvironmentException
public java.util.List createWarningsForChangeOrder(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
pEnvironmentChangeState
- protected java.util.List createWarningsForCurrentOrder()
protected java.util.List createWarningsForNewOrder(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState)
If price lists are in use and there's no price list changes included, the incoming order is checked to make sure all items in the order can be priced by the current price lists.
pEnvironmentChangeState
- public atg.commerce.order.Order getOriginalOrder(atg.commerce.order.Order pOrder)
pOrder
- public void initializeCustomerPricingModels() throws atg.svc.agent.environment.EnvironmentException
atg.svc.agent.environment.EnvironmentException
public void createNewOrder(java.lang.String pApplicationName) throws atg.svc.agent.environment.EnvironmentException
pApplicationName
- the application creating the new order in the environmentatg.svc.agent.environment.EnvironmentException
public void changeOrder(java.lang.String pApplicationName, java.lang.String pOrderId, atg.svc.agent.environment.TicketDispositionOptions pTicketDispositionOptions) throws atg.svc.agent.environment.EnvironmentException
pApplicationName
- pOrderId
- id of the order to be loaded into the environment.pTicketDispositionOptions
- the options used to modify the disposition the currently active
ticket if it needs to change when the order changes. This can be null to use the default handling
behavior.atg.svc.agent.environment.EnvironmentException
public void changeOrder(java.lang.String pApplicationName, atg.commerce.order.Order pOrder, atg.svc.agent.environment.TicketDispositionOptions pTicketDispositionOptions) throws atg.svc.agent.environment.EnvironmentException
pApplicationName
- pOrder
- the order to be loaded into the environment.pTicketDispositionOptions
- the options used to modify the disposition the currently active
ticket if it needs to change when the order changes. This can be null to use the default handling
behavior.atg.svc.agent.environment.EnvironmentException
public boolean isCatalogExplicitlySetForCall()
EnvironmentTools.getCurrentSite()
and
calls isCatalogExplicitlySetForCall(Site)
.
isCatalogExplicitlySetForCall(Site)
,
EnvironmentTools.getCurrentSite()
public boolean isCatalogExplicitlySetForCall(atg.multisite.Site pSite)
If the current call is active the explicit settings are saved in CallState.getStateDataMap()
.
The following keys are used to look up catalog entry based on multi site support.
If the CSRAgentTools.isMultiSiteEnabled()
returns true, the explicit catalog settings are saved
in CSREnvironmentConstants.CSR_CURRENT_CALL_EXPLICIT_SITE_ID_TO_CATALOG
map. This method looks for the catalog entry
in the map. If there is an entry for the pSite
, then this method returns true. False otherwise.
If the CSRAgentTools.isMultiSiteEnabled()
returns false, it is saved in the
CSREnvironmentConstants.CSR_CURRENT_CALL_EXPLICIT_CATALOG
. This method looks for a catalog value in the above key and
if a catalog entry exists, then this method returns true. False otherwise.
pSite
- public boolean isPriceListExplicitlySetForCall()
public boolean isSalePriceListExplicitlySetForCall()
public void cleanCatalogTreeState(atg.web.tree.TreeState treeState)
treeState
- tree state objectpublic void cleanPaymentGroupContainerService()
PaymentGroupMapContainer
.
This method cleans any stale data. This method sets PaymentGroupMapContainer.setDefaultPaymentGroupName(String)
to null.
Also this method removes all payment groups from the PaymentGroupMapContainer
and cipi's from the
CommerceIdentifierPaymentInfoContainer
public void changeViewOrder(java.lang.String pViewOrderId) throws atg.svc.agent.environment.EnvironmentException
pViewOrderId
- atg.svc.agent.environment.EnvironmentException
public void loadViewOrderAndProfile(atg.commerce.order.Order pOrder) throws atg.svc.agent.environment.EnvironmentException
pOrder
- atg.svc.agent.environment.EnvironmentException
public java.lang.String getUserResource(java.lang.String pKey, java.lang.Object[] pMsgArgs, java.util.Locale pLocale)
pKey
- pMsgArgs
- msg argumentspLocale
- the localepublic java.lang.String getServerResource(java.lang.String pKey, java.lang.Object[] pMsgArgs)
pKey
- pMsgArgs
- public boolean isReturnExchange()
public boolean doSitesShare(java.lang.String pSiteId1, java.lang.String pSiteId2) throws atg.svc.agent.environment.EnvironmentException
This method calls SiteGroupManager.doSitesShare(String, String, String)
to compare
two given sites. If the two given sites share the same cart, this method true. Otherwise false.
pSiteId1
- The id of the first site to comparepSiteId2
- The id of the second site to compareatg.svc.agent.environment.EnvironmentException
SiteGroupManager.doSitesShare(String, String, String)
,
CSC supports only cart sharable type
public CurrentCatalogHolder getCurrentCatalogHolder() throws atg.svc.agent.environment.EnvironmentException
CurrentCatalogHolder
component and returns the same.atg.svc.agent.environment.EnvironmentException
public atg.repository.RepositoryItem getUsersCatalog(atg.repository.RepositoryItem pProfile, atg.multisite.Site pSite) throws atg.svc.agent.environment.EnvironmentException
The CustomCatalogTools.determineCatalog(RepositoryItem, RepositoryItem)
is called
to get the catalog. If the above method does not return any catalog, then
the getDefaultCatalog()
is used to return the application default catalog.
pProfile
- pSite
- atg.commerce.pricing.priceLists.PriceListException
atg.svc.agent.environment.EnvironmentException
CustomCatalogTools.determineCatalog(RepositoryItem, RepositoryItem)
,
getDefaultCatalog()
public boolean isSiteValidForEnvironment(java.lang.String pSiteId) throws atg.svc.agent.environment.EnvironmentException
If any of the following conditions is met, the site is invalid and this method returns false.
pSiteId
. If the site id is empty, this method returns false.pSiteId
- atg.multisite.SiteContextException
atg.svc.agent.environment.EnvironmentException
SiteManager#isSiteActive(RepositoryItem)}
,
SiteContextManager.getSite(String)
public boolean isSiteValidForEnvironment(atg.repository.RepositoryItem pSite) throws atg.svc.agent.environment.EnvironmentException
If any of the following conditions is met, the site is invalid and this method returns false.
pSiteId
. If the site id is empty, this method returns false.pSite
- site to validateatg.svc.agent.environment.EnvironmentException
#isSiteValidForEnvironment(String)}
public atg.repository.RepositoryItem getCatalogFromCallState(java.lang.String pSiteId) throws atg.svc.agent.environment.EnvironmentException
This method looks in the site to catalog map state data to find out if there is an explicit catalog selection for a site. if there is an explicit catalog selection for the site, then that catalog is returned.
pSiteId
- atg.svc.agent.environment.EnvironmentException
protected void initializeShippingGroupContainerService(atg.userprofiling.Profile pProfile, atg.commerce.order.Order pOrder) throws atg.svc.agent.environment.EnvironmentException
ShippingGroupMapContainerService
.
pProfile
- if the profile is not null, then shipping groups are initialized from the profilepOrder
- if the order is not null, then shipping groups are initialized from the profileatg.svc.agent.environment.EnvironmentException
CommerceItemShippingInfoTools#clearShippingGroups(CommerceItemShippingInfoContainer, ShippingGroupMapContainer)}
,
CommerceItemShippingInfoTools.clearCommerceItemShippingInfos(CommerceItemShippingInfoContainer, ShippingGroupMapContainer)
,
CommerceItemShippingInfoTools.initializeUserShippingMethods(ShippingGroupMapContainer, Profile, String[], Map)
,
CommerceItemShippingInfoTools.initializeBasedOnOrder(Order, CommerceItemShippingInfoContainer, ShippingGroupMapContainer, Collection, boolean)
,
CommerceItemShippingInfoTools.removeDeletedShippingGroups(ShippingGroupMapContainer)
protected boolean shouldInitializePricingModelHolder(atg.svc.agent.environment.EnvironmentChangeState pEnvironmentChangeState) throws atg.svc.agent.environment.EnvironmentException
This method returns true if either the order or user is being changed in the environment.
pEnvironmentChangeState
- atg.svc.agent.environment.EnvironmentException