public class CSRAgentTools
extends atg.agent.AgentTools
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
AGENTRESOURCES |
static java.lang.String |
APPROVAL_ACCEPTED
the name of the confirmation email template for approving an order
|
static java.lang.String |
APPROVAL_REJECTED
the name of the confirmation email template for rejecting an order
|
static java.lang.String |
BYPASS_EXPIRED_PROMOTIONS_CHECK_PIPELINE_PARAM
The extra parameter name used to bypass the expired promotions checks in the processOrder pipeline
|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
CSC_BYPASS_PAYMENT_AUTHORIZATIONS_PIPELINE_PARAM
The name used to pass the bypassPaymentAuthorizations flag through the extra parameter map to the pipeline executions
|
static java.lang.String |
CSC_CURRENTTICKET_PIPELINE_PARAM
The name used to pass the current ticket through the extra parameter map to the pipeline executions.
|
static java.lang.String |
CSR_ORDER_RESOURCE_NAME |
static java.lang.String |
DEFAULT_BASE_PROMOTION_STATES_PATH |
static java.lang.String |
DEFAULT_WALLET_HOLDER_PATH
Default location of promotions browser components if not overridden in configuration
|
static java.lang.String |
DEFAULT_WALLET_PROMOTION_STATES_PATH |
protected java.lang.String |
mBasePromotionStatesPath |
protected CSRCloneEditManager |
mCloneEditManager |
protected java.lang.String[] |
mCloneEditOrderStates |
protected java.lang.String[] |
mCommerceItemHighlightedStates |
protected atg.commerce.order.CommerceItemManager |
mCommerceItemManager |
protected atg.nucleus.ServiceMap |
mConfirmationEmailMap |
protected CSREnvironmentTools |
mCSREnvironmentTools |
protected atg.svc.agent.customer.CustomerProfileTools |
mCustomerProfileTools |
protected java.util.Map |
mDuplicateOrderExcludedOrderPropertiesMap |
protected java.util.Properties |
mDuplicateOrderExcludedProperties |
protected java.lang.String[] |
mFulfilledOrderStates |
protected atg.web.messaging.MessageTools |
mMessageTools |
protected boolean |
mMultiSiteEnabled |
protected java.lang.String[] |
mNonModifiableOrderStates |
protected java.lang.String[] |
mNonModifiablePaymentGroupStates |
protected java.lang.String[] |
mOrderHighlightedStates |
protected java.lang.String[] |
mPaymentGroupHighlightedStates |
protected boolean |
mPersistConfirmationEmails |
protected atg.commerce.pricing.PricingTools |
mPricingTools |
protected atg.userprofiling.PropertyManager |
mProfilePropertyManager |
protected atg.commerce.csr.promotion.PromotionWalletTools |
mPromotionWalletTools |
protected atg.commerce.csr.returns.ReturnTools |
mReturnTools |
protected java.lang.String |
mSalePriceListPropertyName |
protected boolean |
mSendEmailInSeparateThread |
static java.lang.String |
MSG_CONFIRMATION_EMAIL_SENT |
static java.lang.String |
MSG_COULD_NOT_SAVE_CLONED_ORDER |
static java.lang.String |
MSG_COULD_NOT_SAVE_ORDER |
static java.lang.String |
MSG_ERROR_WHILE_CLONING_ADDRESS |
static java.lang.String |
MSG_ERROR_WHILE_COPY_ADDRESS |
static java.lang.String |
MSG_NO_CREDIT_CARD |
static java.lang.String |
MSG_NO_EXISTING_ADDRESS |
static java.lang.String |
MSG_NO_NICKNAME |
static java.lang.String |
MSG_NO_ORDER |
static java.lang.String |
MSG_NO_PAYMENT_GROUP_CONTAINER |
static java.lang.String |
MSG_NO_PROFILE |
static java.lang.String |
MSG_ORDER_ALREADY_SAVED |
static java.lang.String |
MSG_SEND_CONFIRMATION_NO_ADDR_ERROR |
static java.lang.String |
MSG_SEND_CONFIRMATION_NO_EMAILINFO_ERROR |
protected java.lang.String[] |
mShipItemRelationshipHighlightedStates |
protected java.lang.String[] |
mShippingGroupHighlightedStates |
protected java.lang.String[] |
mShippingGroupShippedStates |
protected atg.multisite.SiteContextManager |
mSiteContextManager |
protected atg.multisite.SiteManager |
mSiteManager |
protected java.lang.String[] |
mSubmittedOrderStates |
protected atg.userprofiling.email.TemplateEmailSender |
mTemplateEmailSender |
protected java.lang.String |
mWalletHolderPath |
protected java.lang.String |
mWalletPromotionStatesPath |
static java.lang.String |
NEW_ORDER_TEMPLATE_NAME
The confirmation template name used for new orders
|
static java.lang.String |
ORDER_EXCHANGE_TEMPLATE_NAME
The confirmation template name used for order exchanges
|
static java.lang.String |
ORDER_RETURN_TEMPLATE_NAME
The confirmation template name used for order returns
|
static java.lang.String |
ORDER_UPDATE_TEMPLATE_NAME
The confirmation template name used for order updates
|
static java.lang.String |
SCHEDULE_ADD_TEMPLATE_NAME
the name of the confirmation email template for adding a new scheduled order
|
static java.lang.String |
SCHEDULE_UPDATE_TEMPLATE_NAME
the name of the confirmation email template for updating a scheduled order
|
static java.lang.String |
SCHEDULED_ORDER_UPDATE_TEMPLATE_NAME
The confirmation template name used for scheduled order updates
|
static java.lang.String |
TEMPLATE_WINDOW_SCOPE_KEY |
static java.lang.String |
TICKETID_PARAMETER
The extra parameter name used to pass the ticket id to pipeline execution
|
COMMENT_AGENT_PROPERTY_NAME, COMMENT_COMMENT_PROPERTY_NAME, COMMENT_CREATIONDATE_PROPERTY_NAME, COMMENT_OWNER_PROPERTY_NAME, NEW_PASSWORD_PARAM_NAME, sBundle
Constructor and Description |
---|
CSRAgentTools() |
Modifier and Type | Method and Description |
---|---|
java.util.Map |
addBypassExpiredPromotionsCheckParameter(java.util.Map pExtraParameters)
Deprecated.
|
java.util.Map |
addBypassPaymentGroupAuthorizationParameter(java.util.Map pExtraParameters)
Deprecated.
|
java.util.Map |
addBypassPromotionVetoersParameter(java.util.Map pExtraParameters)
Deprecated.
|
java.util.Map |
addCurrentOrderPricingParameters(java.util.Map pExtraParameters)
Adds all the extra parameters used for pricing operations against the current
Order.
|
java.util.Map |
addCurrentTicketParameter(java.util.Map pExtraParameters)
Adds the current ticket to the extra parameter map
|
java.util.Map |
addItemPriceSourceParameter(java.util.Map pExtraParameters,
java.util.List pPricingOverrides)
Deprecated.
|
void |
addItemToCollection(atg.repository.RepositoryItem pItem,
atg.repository.RepositoryItem pItemToAdd,
java.lang.String pPropertyName)
Adds an item from a collection property.
|
void |
addItemToMap(atg.repository.RepositoryItem pItem,
atg.repository.RepositoryItem pItemToAdd,
java.lang.Object pKey,
java.lang.String pPropertyName)
Adds an item to a map property.
|
void |
addItemToProperty(atg.repository.RepositoryItem pItem,
atg.repository.RepositoryItem pItemToSet,
java.lang.String pPropertyName)
Puts an item in an item's single valued property.
|
java.util.Map |
addListPriceListParameter(java.util.Map pExtraParameters,
atg.repository.RepositoryItem pListPriceList)
Adds the given pricelist as the list pricelist to the extra parameter map
|
void |
addOrderPromotionsToHolder(atg.commerce.order.Order pOrder,
atg.commerce.pricing.PricingModelHolder pPricingModelHolder)
Adds the promotions that are associated with the order to the pricing model holder.
|
java.util.Map |
addPriceListParameter(java.util.Map pExtraParameters)
This method adds the environment's current price list and sale price list
to the extra parameter map that's used for pricing operations in CSR.
|
java.util.Map |
addSalePriceListParameter(java.util.Map pExtraParameters,
atg.repository.RepositoryItem pSalePriceList)
Adds the given pricelist as the sale pricelist to the extra parameter map
|
boolean |
areAllGroupsShipped(atg.commerce.order.Order pOrder,
java.lang.String[] pShippingGroupShippedStates)
Returns true if all
ShippingGroup s in
the Order are in a "shipped". |
boolean |
areAnyItemsShipped(atg.commerce.order.Order pOrder)
Returns true if any
ShippingGroupCommerceItemRelationship in
the Order has a state of "DELIVERED" |
boolean |
arePriceOverrides(atg.commerce.order.Order pOrder)
Returns true if there are any agent applied price
overrides on the order
|
boolean |
associateTicketAndOrder(java.lang.String pOrderId,
atg.repository.MutableRepositoryItem pTicket)
This method associates a given or current active ticket to the order that is passed in.
|
void |
claimCoupon(java.lang.String pClaimCode,
java.lang.String pPostClaimPricingOperation,
java.util.Map pRepriceParameterMap)
If the order hasn't been submitted yet, the ClaimableManager is
called to claim the coupon.
|
void |
claimCouponForSubmittedOrder(atg.commerce.order.edit.CloneEditState pCloneEditState,
java.lang.String pClaimCode,
atg.commerce.order.Order pOrder,
atg.repository.RepositoryItem pCustomerProfile,
atg.repository.RepositoryItem pAgentProfile,
SubmittedOrderPricingModelHolder pSubmittedOrderPricingModelHolder,
java.lang.String pRepricingOperation,
java.util.Locale pUserLocale,
java.util.Map pExtraParametersMap)
Claims a coupon for use with an already submitted order
|
java.util.List |
collectUniqueExistingAddresses(atg.commerce.order.purchase.ShippingGroupMapContainer pShippingGroupMapContainer,
atg.commerce.order.purchase.PaymentGroupMapContainer pPaymentGroupMapContainer,
atg.commerce.order.Order pOrder)
This method gets the unique addresses from the ShippingGroupMapContainer and
PaymentGroupMapContainer and Order.
|
java.util.Locale |
convertLocale(java.lang.Object pLocale)
Convert an object to a Locale.
|
void |
copyContactInfoToCreditCard(atg.core.util.Address pExistingAddress,
atg.commerce.order.CreditCard pCreditCard)
This method copies the given address to the CreditCard object.
|
void |
copyContactInfoToCreditCard(atg.repository.RepositoryItem pExistingAddress,
atg.commerce.order.CreditCard pCreditCard)
This method copies the given address to the CreditCard object.
|
atg.payment.creditcard.CreditCardInfo |
createCreditCardInfo(atg.repository.RepositoryItem pCreditCard)
Create a (Generic)CreditCardInfo instance from a credit card
repository item
|
protected java.util.Map |
createDuplicateOrderPropExceptionsMap()
This method is a helper method which is used by the duplicateOrder method.
|
atg.repository.MutableRepositoryItem |
createNewAgentOrderCommentItem()
Creates a new transient comment item in the order repository
|
atg.repository.RepositoryItem |
createOrderComment(atg.commerce.order.Order pOrder,
atg.repository.RepositoryItem pCustomerProfile,
atg.repository.RepositoryItem pAgentProfile,
java.lang.String pComment,
java.lang.String pTicketId)
Creates a new comment item for the given order.
|
java.util.Map |
createPromotionValueMap(atg.commerce.order.Order pOrder,
boolean pIncludeOrderPromos,
boolean pIncludeItemPromos,
boolean pIncludeShippingPromos,
boolean pIncludeTaxPromos)
Deprecated.
|
atg.commerce.order.Order |
duplicateOrder(java.lang.String pOrderId,
java.util.Map pPropExceptions,
java.util.Map pExcludedProperties)
Duplicates an order into a new incomplete order.
|
void |
ensureOrderAmountRemainingType(atg.commerce.order.purchase.CommerceIdentifierPaymentInfoContainer pCommerceIdentifierPaymentInfoContainer,
atg.commerce.order.purchase.PaymentGroupMapContainer pPaymentGroupMapContainer)
Inspects the OrderPaymentInfos in the container and attempts to ensure one
of them has an ORDER_AMOUNT_REMAINING relationship type.
|
atg.repository.RepositoryItem |
findDuplicateUser(java.util.Dictionary pValues)
This methods will attempt to find a profile based on the properties specfied
by the
duplicatProfileProperties property. |
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.
|
int |
findMatchingAddress(java.lang.Object pAddress,
java.util.List pAddressList)
This method iterates through all available addresses and finds the matching address in the
list of available addresses and returns the matching or equivalent address that is in the available address list.
|
void |
findPropertyChanges(java.lang.Object pNewValues,
java.lang.Object pOldValues,
java.lang.String[] pPropertyNames,
java.util.List pUpdates)
This method finds all property information changes.
|
java.lang.String |
formatAmount(double pAmount,
java.lang.String pCurrencyCode)
Formats the given input amount value as a string using the given currency
and the agent's display locale.
|
java.util.Map |
generateConfirmationTemplateDefaultParams(ConfirmationInfo pConfirmationInfo)
Creates a map with the confirmation info object added using
the key defined by the constant
CONFIRMATIONEMAIL_PARAM_NAME |
java.util.Map |
generateConfirmationTemplateDefaultParams(atg.commerce.order.Order pOrder,
atg.repository.RepositoryItem pProfile)
Deprecated.
|
java.lang.String |
getActiveCustomerCurrencyCode()
Get the ISO 4217 currency code for pricing (e.g.
|
java.text.DecimalFormatSymbols |
getActiveCustomerDecimalFormatSymbols()
Get the DecimalFormatSymbols from the active customer's pricing
local, or if that's unavailable, from the
PricingTools.defaultLocale property.
|
java.util.Locale |
getActiveCustomerDisplayLocale()
Returns the active customer's display locale
|
java.util.Locale |
getActiveCustomerPricingLocale()
Returns the current pricing locale
|
java.lang.String |
getAgentDefaultSiteId()
This method is used to get the agents' site.
|
atg.commerce.pricing.PricingAdjustment |
getAgentOverrideDetail(atg.commerce.order.CommerceItem pItem)
Deprecated.
in favor of getAgentOverrideDetails which return all details when there is more
than one.
|
java.util.List |
getAgentOverrideDetails(atg.commerce.order.CommerceItem pItem)
Returns the PricingAdjustments put on by CSC when an agent overrides the price.
|
java.lang.String |
getBasePromotionStatesPath()
Provides a handle to the base promotion states
|
atg.repository.RepositoryItem |
getClaimableItem(java.lang.String pId)
Return the repository item from the claimable repository whose id is equal
to pId.
|
atg.commerce.claimable.ClaimableManager |
getClaimableManager()
Returns the ClaimableManager is used in determining the user's GiftCertificates.
|
java.util.Map |
getCloneContactInfoExcludedProperties() |
java.util.Map |
getCloneContactInfoPropExceptions() |
protected java.util.Map |
getCloneDefaultShippingInfoExcludedProperties()
Returns the map of properties that should be excluded from the clone of the default shipping address
|
protected java.util.Map |
getCloneDefaultShippingInfoPropExceptions()
Returns the Hierarchical map of property name exceptions that are used when doing a deep clone of
the default shipping address.
|
CSRCloneEditManager |
getCloneEditManager() |
java.lang.String[] |
getCloneEditOrderStates() |
java.lang.String[] |
getCommerceItemHighlightedStates()
Returns the commerce item states that should appear
highlighted in the UI
|
atg.commerce.order.CommerceItemManager |
getCommerceItemManager() |
atg.commerce.profile.CommercePropertyManager |
getCommercePropertyManager() |
atg.nucleus.ServiceMap |
getConfirmationEmailMap()
Gets the ConfirmationEmailMap
|
java.lang.String |
getConfirmationTemplateToUse()
Deprecated.
|
CSRAgentMessagingTools |
getCSRAgentMessagingTools()
Get the AgentMessagingTools cast to CSRAgentMessagingTools
|
CSRConfigurator |
getCSRConfigurator() |
CSREnvironmentTools |
getCSREnvironmentTools() |
java.lang.String |
getCurrencyForPriceList(atg.repository.RepositoryItem pPricelist)
returns the currency for the given price list
|
java.lang.String |
getCurrentOrderCurrencySymbolInFormattingLocale()
This method returns the current order's currency symbol in the formatting locale.
|
atg.commerce.csr.returns.ReturnRequest |
getCurrentReturnRequest()
This method gets the return request from the current order.
|
atg.svc.agent.customer.CustomerProfileTools |
getCustomerProfileTools() |
java.util.Map |
getDuplicateOrderExcludedOrderPropertiesMap()
Generates an the excluded property map based on the
duplicateOrderExcludedProperties property. |
java.util.Properties |
getDuplicateOrderExcludedProperties()
Returns the excluded order properties when duplicating an order
|
java.lang.String[] |
getDuplicateProfileProperties() |
java.lang.String[] |
getFulfilledOrderStates() |
java.lang.String[] |
getIncompleteOrderStates() |
atg.web.messaging.MessageTools |
getMessageTools()
Returns the MessageTools component
|
java.lang.String[] |
getNonModifiableOrderStates()
Returns the order states in which an order cannot be
modified
|
java.lang.String[] |
getNonModifiablePaymentGroupStates()
Returns the payment group states in which a payment group cannot be
modified
|
java.lang.String |
getOrderCommentItemDescriptorName() |
java.lang.String[] |
getOrderHighlightedStates()
Returns the order states that should appear
highlighted in the UI
|
atg.commerce.order.OrderManager |
getOrderManager()
The OrderManager component that will be used to create a new, empty order
|
java.lang.String[] |
getPaymentGroupHighlightedStates()
Returns the payment group states that should appear
highlighted in the UI
|
atg.commerce.pricing.priceLists.PriceListManager |
getPriceListManager() |
atg.commerce.pricing.PricingTools |
getPricingTools() |
java.lang.String |
getPricingToolsDefaultCurrencySymbolInFormattingLocale()
This method gets the currency symbol based on
PricingTools.getDefaultLocale() and then returns
the currency symbol in the user's formatting locale. |
atg.userprofiling.PropertyManager |
getProfilePropertyManager()
Gets the ProfilePropertyManager
|
atg.progressbar.ProgressBarItem |
getProgressBar(java.lang.String pPath)
Resolves the requested progress bar
|
atg.commerce.promotion.PromotionTools |
getPromotionTools() |
atg.commerce.csr.promotion.PromotionWalletTools |
getPromotionWalletTools()
Sets property PromotionWalletTools
|
protected java.lang.Object |
getPropertyValue(java.util.Dictionary pValues,
java.lang.String pName)
Gets the value corresponding to the given name in the given dictionary
|
atg.commerce.order.purchase.PurchaseProcessHelper |
getPurchaseProcessHelper()
Returns property purchaseProcessHelper
|
double |
getRemainingAmount(atg.repository.RepositoryItem pClaimable)
Deprecated.
|
atg.commerce.csr.returns.ReturnTools |
getReturnTools() |
java.lang.String |
getSalePriceListPropertyName()
Returns the name of the profile property used for holding the
sale price list
|
atg.commerce.csr.scenario.MessageDispatcher |
getScenarioMessageDispatcher() |
java.lang.String[] |
getShipItemRelationshipHighlightedStates()
Returns the order states that should appear
highlighted in the UI
|
java.lang.String[] |
getShippingGroupHighlightedStates() |
java.lang.String[] |
getShippingGroupShippedStates()
Returns the shipping group states that indicate a shipping
group has shipped
|
atg.repository.RepositoryItem |
getSiteCatalog(atg.multisite.Site pSite,
atg.repository.RepositoryItem pProfile)
This method returns catalog for the site only if the multi site is enabled.
|
java.util.Collection<atg.repository.RepositoryItem> |
getSiteCatalogs(java.util.Collection<atg.multisite.Site> pSites,
atg.repository.RepositoryItem pProfile)
This method returns catalogs only if the multi site is enabled.
|
java.util.Collection<atg.repository.RepositoryItem> |
getSiteCatalogs(java.lang.String[] pSiteIds,
atg.repository.RepositoryItem pProfile)
This method returns site catalogs.
|
atg.multisite.SiteContextManager |
getSiteContextManager()
Returns the siteContextManager
|
atg.multisite.SiteManager |
getSiteManager()
Returns the siteManager
|
java.lang.String[] |
getSubmittedOrderStates() |
atg.userprofiling.email.TemplateEmailSender |
getTemplateEmailSender()
Gets the TemplateEmailSender
|
java.lang.String |
getTicketOrdersPropertyName()
Returns the ticketOrdersPropertyName.
|
double |
getTotalAppeasementValue(atg.commerce.order.Order pOrder)
Returns the total value of agent applied appeasements (credits) on the given Order.
|
double |
getTotalManualAdjustmentValue(atg.commerce.order.Order pOrder)
Returns the total value of the manual adjustments applied to the order.
|
double |
getTotalManualAppeasementValue(atg.commerce.order.Order pOrder)
Returns the total value of manual adjustments if they sum to a credit value.
|
double |
getTotalPriceOverrideAppeasementValue(atg.commerce.order.Order pOrder)
Returns the total appeasement(credit) value of item price overrides on the given
Order.
|
double |
getTotalPriceOverrideValue(atg.commerce.order.Order pOrder)
Returns the total value of item price overrides on the given
Order.
|
java.lang.String |
getUserResource(java.lang.String pKey,
java.lang.Object[] pMsgArgs,
java.util.Locale pLocale)
Returns a resource from the user resource bundle
|
java.lang.String |
getValidatePaymentGroupsChainId()
Return the ValidatePaymentGroupsChainId property.
|
java.lang.String |
getWalletHolderPath()
Provides a handle to the wallet for the current request
|
java.lang.String |
getWalletPromotionStatesPath()
Provides a handle to the wallet promotion states
|
void |
initializeDefaultAddresses(atg.repository.RepositoryItem pProfile,
java.lang.String pDefaultShippingAddressPropertyName,
java.lang.String pDefaultBillingAddressPropertyName,
boolean pCloneDefaultShippingForBilling)
Initializes the default shipping and default billing addresses for the profile.
|
boolean |
isAgentOverridePrice(atg.commerce.order.CommerceItem pItem)
Determines if the item has been priced with an agent override
price.
|
boolean |
isAllowCloningContactInfo() |
boolean |
isCloneEditState()
This method grabs the order from the current environment and
returns true if the order should use the clone edit
handlers for editing.
|
boolean |
isCloneEditState(atg.commerce.order.Order pOrder)
returns true if the order should use the clone edit
handlers for editing.
|
protected boolean |
isFulfilledOrderState(java.lang.String pState)
Deprecated.
|
boolean |
isHighlightedState(java.lang.Object pCommerceObject)
Determines if the objects current state is one of the configured
highlighted states.
|
boolean |
isMultiSiteEnabled()
This method decides whether the CSC application supports multi site or not based on the following rules.
|
boolean |
isOrderAdjusted(atg.commerce.order.Order pOrder)
Returns true if there are any agent applied price overrides or
manual adjustments on the order
|
boolean |
isOrderFulfilled(atg.commerce.order.Order pOrder)
Deprecated.
|
boolean |
isOrderFulfilled(atg.repository.RepositoryItem pOrderItem)
Deprecated.
|
boolean |
isOrderIncomplete(atg.commerce.order.Order pOrder)
Determines if an order is incomplete based on the states defined
in the
incompleteOrderStates property. |
boolean |
isOrderIncomplete(atg.repository.RepositoryItem pOrderItem)
Determines if an order is incomplete based on the states defined
in the
incompleteOrderStates property. |
boolean |
isOrderInModifiableState(atg.commerce.order.Order pOrder)
Returns true if the order is in a modifiable state
|
boolean |
isOrderModifiable(atg.commerce.order.Order pOrder)
Determines if an order is modifiable
|
boolean |
isOrderSubmitted(atg.commerce.order.Order pOrder)
Determines if an order is submitted based on the states defined
in the
submittedOrderStates property. |
boolean |
isOrderSubmitted(atg.repository.RepositoryItem pOrderItem)
Determines if an order is submitted based on the states defined
in the
submittedOrderStates property. |
boolean |
isOrderSupportedforUpdate(java.lang.Object pOrder)
Checks if an order has supported payment group types and hence is supported for update.
|
boolean |
isPaymentGroupInModifiableState(atg.commerce.order.PaymentGroup pPaymentGroup)
Returns true if the payment group is in a modifiable state
|
boolean |
isPersistConfirmationEmails()
Gets the PersistConfirmationEmails
|
boolean |
isPersistOrderForTransientUsers()
Returns the persistOrderForTransientUsers.
|
boolean |
isPriceListSameCurrencyAsOrder(atg.commerce.order.Order pOrder,
atg.repository.RepositoryItem pPricelist)
Returns true if the order and price list both specify the same currency
|
boolean |
isSendEmailInSeparateThread()
Returns boolean indicating whether the new account email is sent in a separate thread.
|
boolean |
isTransactionMarkedAsRollBack()
Returns true if the transaction associated with the current thread
is marked for rollback.
|
boolean |
isUseRequestLocale()
Returns property UseRequestLocale
|
java.lang.String |
maskCreditCardNumber(java.lang.String pCreditCardNumber)
Masks a credit card number.
|
void |
overrideItemPrice(atg.commerce.order.CommerceItem pItem,
double pNewAmount,
atg.commerce.order.Order pOrder,
java.util.Locale pUserLocale,
java.lang.String pTicketId)
Overrides the price of the given commerce item to the new amount.
|
protected void |
overridePriceInfoAmount(atg.commerce.pricing.AmountInfo pAmountInfo,
double pNewAmount,
double pTotalAdjustment,
long pQuantity,
java.lang.String pReasonDescription)
Overrides the price of the given price info, marks it as final, clears the
pricing adjustments and adds a new PricingAdjustment for the overriden price.
|
void |
overrideShippingPrice(atg.commerce.order.ShippingGroup pShippingGroup,
double pNewAmount,
atg.commerce.order.Order pOrder,
java.util.Locale pUserLocale,
java.lang.String pTicketId)
Overrides the price of the given shipping group to the new amount.
|
java.lang.Double |
parseAmount(java.lang.String pAmount,
java.lang.String pCurrencyCode)
Parses the given input amount value using the given currency
and the agent's display locale.
|
static java.util.Collection |
parseString(java.lang.String pString)
Parse a String which is delimited by "|" into a collection of strings.
|
boolean |
persistCurrentOrder()
This method saves the current order to the repository for both transient and non-transient
orders.
|
void |
populateAnonymousCustomerProfileFromOrder(atg.repository.RepositoryItem pProfile,
atg.commerce.order.Order pOrder)
Populates properties of the profile from information contained on the order.
|
void |
populateAnonymousCustomerProfileFromOrder(atg.repository.RepositoryItem pProfile,
atg.repository.RepositoryItem pOrder)
Populates properties of the profile from information contained on the order.
|
void |
populateCustomerProfileFromAddress(atg.repository.RepositoryItem pProfile,
atg.repository.RepositoryItem pAddress)
Populates a profile from the information captured in the address.
|
void |
recreateInitialDetailsForItemMarkedAsFinal(atg.commerce.order.CommerceItem pItem,
double pAmount,
java.util.Locale pUserLocale,
atg.repository.RepositoryItem pProfile,
java.lang.String pDescription)
Recreates the detailed price infos for the item that has been marked as final.
|
void |
recreateInitialDetailsForItemsMarkedAsFinal(atg.commerce.order.Order pOrder,
java.util.Locale pUserLocale,
atg.repository.RepositoryItem pProfile)
Recreates the item detailed price infos for all items in the order that have been marked as final.
|
void |
removeDeletedPaymentGroups(atg.commerce.order.purchase.PaymentGroupMapContainer pPaymentGroupMapContainer,
java.util.List pRemovedEntries)
Some payment groups are deleted from the repository.
|
void |
removeDeletedShippingGroups(atg.commerce.order.purchase.ShippingGroupMapContainer pShippingGroupMapContainer,
java.util.List pRemovedEntries)
Some shipping groups are deleted from the repository.
|
void |
removeItemFromCollection(atg.repository.RepositoryItem pItem,
java.lang.String pPropertyName,
atg.repository.RepositoryItem pRemoveItem)
Removes an item from a collection property.
|
void |
removeItemFromMap(atg.repository.RepositoryItem pItem,
java.lang.String pPropertyName,
java.lang.Object pKey)
Removes an item from a map property.
|
void |
removeItemFromProperty(atg.repository.RepositoryItem pItem,
java.lang.String pPropertyName)
Removes a reference to an item by setting the property to null.
|
void |
repriceOrder(java.lang.String pRepricingOperation,
atg.commerce.order.Order pOrder,
atg.commerce.pricing.PricingModelHolder pUserPricingModels,
java.util.Locale pLocale,
atg.repository.RepositoryItem pCustomerProfile,
atg.repository.RepositoryItem pAgentProfile,
java.util.Map pExtraParameters,
atg.commerce.util.PipelineErrorHandler pErrorHandler)
Reprices an order.
|
protected void |
resetHandlingInstructionReferences(atg.repository.RepositoryItem pOriginalOrder,
atg.repository.RepositoryItem pCloneOrder)
Resets the commerceItemId and shippingGroupId properties of the clone handling instructions to point at
commerce items and shipping groups in the clone order.
|
protected void |
resetReturnInfoForCopy(atg.commerce.order.Order pOrder)
Resets the refund info in the order's commerce items and their
shipping relationships.
|
boolean |
sendAutomaticConfirmation(ConfirmationInfo pConfirmationInfo)
Send an automatic confirmation message.
|
boolean |
sendAutomaticConfirmation(atg.commerce.order.Order pOrder,
atg.repository.RepositoryItem pProfile)
Deprecated.
|
void |
sendConfirmationEmail(ConfirmationInfo pConfirmationInfo)
Use the Template Email Sender to send a confirmation email.
|
void |
sendConfirmationEmail(atg.commerce.order.Order pOrder,
atg.repository.RepositoryItem pProfile,
java.lang.String pToAddress)
Deprecated.
|
void |
setAddressFirstAndLastNameFromProfile(atg.repository.RepositoryItem pAddress,
atg.repository.RepositoryItem pProfile)
Sets the address first name and last name to the values in the profile.
|
void |
setAllowCloningContactInfo(boolean pAllowCloningContactInfo) |
void |
setBasePromotionStatesPath(java.lang.String pBasePromotionStatesPath) |
void |
setClaimableManager(atg.commerce.claimable.ClaimableManager pClaimableManager)
Specifies the ClaimableManager to use in determining the user's GiftCertificates.
|
void |
setCloneContactInfoExcludedProperties(java.util.Map pCloneContactInfoExcludedProperties) |
void |
setCloneContactInfoPropExceptions(java.util.Map pCloneContactInfoPropExceptions) |
void |
setCloneEditManager(CSRCloneEditManager pCloneEditManager) |
void |
setCloneEditOrderStates(java.lang.String[] pCloneEditOrderStates)
Sets array of order states that indicate that an order should use
clone editing when loaded for modifications.
|
void |
setCommerceItemHighlightedStates(java.lang.String[] pCommerceItemHighlightedStates) |
void |
setCommerceItemManager(atg.commerce.order.CommerceItemManager pCommerceItemManager) |
void |
setCommercePropertyManager(atg.commerce.profile.CommercePropertyManager pCommercePropertyManager)
Sets the component that defines properties of the profile for Commerce
|
void |
setConfirmationEmailMap(atg.nucleus.ServiceMap pConfirmationEmailMap)
Sets the ConfirmationEmailMap
|
void |
setConfirmationTemplateToUse(java.lang.String pTemplateToUse)
Deprecated.
|
void |
setCSRConfigurator(CSRConfigurator pCSRConfigurator)
Sets the CSRConfigurator
|
void |
setCSREnvironmentTools(CSREnvironmentTools pCSREnvironmentTools) |
void |
setCustomerProfileTools(atg.svc.agent.customer.CustomerProfileTools pCustomerProfileTools) |
void |
setDuplicateOrderExcludedProperties(java.util.Properties pDuplicateOrderExcludedProperties)
set the property DuplicateOrderExcludedProperties
|
void |
setDuplicateProfileProperties(java.lang.String[] pDuplicateProfileProperties)
Sets property duplicateNameCheckPropertyNames
|
void |
setFulfilledOrderStates(java.lang.String[] pFulfilledOrderStates)
Sets array of order states that indicate that an order is fulfilled
|
void |
setIncompleteOrderStates(java.lang.String[] pIncompleteOrderStates)
Sets array of order states that indicate that an order is incomplete
|
void |
setMessageTools(atg.web.messaging.MessageTools pMessageTools) |
void |
setNonModifiableOrderStates(java.lang.String[] pNonModifiableOrderStates) |
void |
setNonModifiablePaymentGroupStates(java.lang.String[] pNonModifiablePaymentGroupStates) |
void |
setOrderCommentItemDescriptorName(java.lang.String pOrderCommentItemDescriptorName)
Sets the name of the "comment" item descriptor in the order repository
|
void |
setOrderHighlightedStates(java.lang.String[] pOrderHighlightedStates) |
void |
setOrderManager(atg.commerce.order.OrderManager pOrderManager)
Sets the OrderManager component that will be used to create a new, empty order
|
void |
setPaymentGroupHighlightedStates(java.lang.String[] pPaymentGroupHighlightedStates) |
void |
setPersistConfirmationEmails(boolean pPersistConfirmationEmails)
Sets the PersistConfirmationEmails
|
void |
setPersistOrderForTransientUsers(boolean pPersistOrderForTransientUsers)
Sets the persistOrderForTransientUsers.
|
void |
setPriceListManager(atg.commerce.pricing.priceLists.PriceListManager pPriceListManager)
Sets the Price List Manager
|
void |
setPricingTools(atg.commerce.pricing.PricingTools pPricingTools) |
void |
setProfilePropertyManager(atg.userprofiling.PropertyManager pProfilePropertyManager)
Sets the ProfilePropertyManager
|
void |
setPromotionTools(atg.commerce.promotion.PromotionTools pPromotionTools) |
void |
setPromotionWalletTools(atg.commerce.csr.promotion.PromotionWalletTools pPromotionWalletTools)
Returns property PromotionWalletTools
|
protected void |
setPropertiesOfOrderComment(atg.repository.MutableRepositoryItem pComment,
java.lang.String pCommentData,
java.util.Date pCreationDate,
java.lang.String pOwnerId,
atg.repository.RepositoryItem pAgent)
Sets the properties of an order comment item
|
void |
setPurchaseProcessHelper(atg.commerce.order.purchase.PurchaseProcessHelper pPurchaseProcessHelper)
Sets property purchaseProcessHelper
|
void |
setReturnTools(atg.commerce.csr.returns.ReturnTools pReturnTools)
Sets the return tools
|
void |
setSalePriceListPropertyName(java.lang.String pSalePriceListPropertyName) |
void |
setScenarioMessageDispatcher(atg.commerce.csr.scenario.MessageDispatcher pScenarioMessageDispatcher)
Component that will send the initializeProfile event
|
void |
setShipItemRelationshipHighlightedStates(java.lang.String[] pShipItemRelationshipHighlightedStates) |
void |
setShippingGroupHighlightedStates(java.lang.String[] pShippingGroupHighlightedStates) |
void |
setShippingGroupShippedStates(java.lang.String[] pShippingGroupShippedStates) |
void |
setSiteContextManager(atg.multisite.SiteContextManager pSiteContextManager)
Sets the siteContextManager
|
void |
setSiteManager(atg.multisite.SiteManager pSiteManager)
Sets the siteManager
|
void |
setSubmittedOrderStates(java.lang.String[] pSubmittedOrderStates)
Sets array of order states that indicate that an order is Submitted
|
void |
setTemplateEmailSender(atg.userprofiling.email.TemplateEmailSender pTemplateEmailSender)
Sets the TemplateEmailSender
|
void |
setTicketOrdersPropertyName(java.lang.String pTicketOrdersPropertyName)
Sets the ticketOrdersPropertyName.
|
void |
setUseRequestLocale(boolean pUseRequestLocale)
Sets property UseRequestLocale
|
void |
setValidatePaymentGroupsChainId(java.lang.String pValidatePaymentGroupsChainId)
Set the ValidatePaymentGroupsChainId property.
|
void |
setWalletHolderPath(java.lang.String pWalletHolderPath) |
void |
setWalletPromotionStatesPath(java.lang.String pWalletPromotionStatesPath) |
boolean |
validateCreditCardExpiration(java.lang.String pMonth,
java.lang.String pYear)
Validates a credit card expiration date
|
boolean |
validateCreditCardNumber(java.lang.String pCreditCardNumber)
Validates a credit card number
|
assignUserToCurrentOrganization, assignUserToOrganization, createNewAgentProfileCommentItem, createProfileComment, generateNewAccountPasswordAndNotification, generateNewAccountTemplateDefaultParams, getAgentMessagingTools, getAgentProfile, getCustomerProfile, getInternalProfileTools, getProfileCommentItemDescriptorName, getProfileTools, getUserDirectoryTools, getUserViewName, initializeRegistrationDate, setAgentMessagingTools, setInternalProfileTools, setProfileCommentItemDescriptorName, setProfileTools, setPropertiesOfComment, setUserDirectoryTools, setUserViewName
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 final java.lang.String CLASS_VERSION
protected static final java.lang.String AGENTRESOURCES
public static final java.lang.String CSR_ORDER_RESOURCE_NAME
public static final java.lang.String BYPASS_EXPIRED_PROMOTIONS_CHECK_PIPELINE_PARAM
public static final java.lang.String TICKETID_PARAMETER
public static final java.lang.String MSG_NO_ORDER
public static final java.lang.String MSG_NO_PROFILE
public static final java.lang.String MSG_ORDER_ALREADY_SAVED
public static final java.lang.String MSG_COULD_NOT_SAVE_CLONED_ORDER
public static final java.lang.String MSG_COULD_NOT_SAVE_ORDER
public static final java.lang.String MSG_NO_EXISTING_ADDRESS
public static final java.lang.String MSG_NO_CREDIT_CARD
public static final java.lang.String MSG_NO_PAYMENT_GROUP_CONTAINER
public static final java.lang.String MSG_NO_NICKNAME
public static final java.lang.String MSG_ERROR_WHILE_CLONING_ADDRESS
public static final java.lang.String MSG_ERROR_WHILE_COPY_ADDRESS
public static final java.lang.String MSG_SEND_CONFIRMATION_NO_EMAILINFO_ERROR
public static final java.lang.String MSG_SEND_CONFIRMATION_NO_ADDR_ERROR
public static final java.lang.String TEMPLATE_WINDOW_SCOPE_KEY
public static final java.lang.String MSG_CONFIRMATION_EMAIL_SENT
public static final java.lang.String NEW_ORDER_TEMPLATE_NAME
public static final java.lang.String ORDER_UPDATE_TEMPLATE_NAME
public static final java.lang.String ORDER_EXCHANGE_TEMPLATE_NAME
public static final java.lang.String ORDER_RETURN_TEMPLATE_NAME
public static final java.lang.String SCHEDULED_ORDER_UPDATE_TEMPLATE_NAME
public static final java.lang.String SCHEDULE_ADD_TEMPLATE_NAME
public static final java.lang.String SCHEDULE_UPDATE_TEMPLATE_NAME
public static final java.lang.String APPROVAL_ACCEPTED
public static final java.lang.String APPROVAL_REJECTED
public static final java.lang.String CSC_CURRENTTICKET_PIPELINE_PARAM
public static final java.lang.String CSC_BYPASS_PAYMENT_AUTHORIZATIONS_PIPELINE_PARAM
public static final java.lang.String DEFAULT_WALLET_HOLDER_PATH
public static final java.lang.String DEFAULT_BASE_PROMOTION_STATES_PATH
public static final java.lang.String DEFAULT_WALLET_PROMOTION_STATES_PATH
protected atg.commerce.csr.promotion.PromotionWalletTools mPromotionWalletTools
protected atg.svc.agent.customer.CustomerProfileTools mCustomerProfileTools
protected atg.multisite.SiteContextManager mSiteContextManager
protected atg.commerce.csr.returns.ReturnTools mReturnTools
protected java.lang.String[] mPaymentGroupHighlightedStates
protected java.lang.String[] mCommerceItemHighlightedStates
protected java.lang.String[] mOrderHighlightedStates
protected java.lang.String[] mShipItemRelationshipHighlightedStates
protected java.lang.String[] mShippingGroupHighlightedStates
protected java.util.Properties mDuplicateOrderExcludedProperties
protected atg.commerce.order.CommerceItemManager mCommerceItemManager
protected java.lang.String[] mShippingGroupShippedStates
protected java.lang.String[] mNonModifiableOrderStates
protected java.lang.String[] mNonModifiablePaymentGroupStates
protected java.lang.String mSalePriceListPropertyName
protected atg.commerce.pricing.PricingTools mPricingTools
protected CSREnvironmentTools mCSREnvironmentTools
protected CSRCloneEditManager mCloneEditManager
protected java.lang.String[] mFulfilledOrderStates
protected java.lang.String[] mSubmittedOrderStates
protected java.lang.String[] mCloneEditOrderStates
protected atg.userprofiling.PropertyManager mProfilePropertyManager
protected boolean mPersistConfirmationEmails
protected boolean mSendEmailInSeparateThread
protected atg.nucleus.ServiceMap mConfirmationEmailMap
protected atg.userprofiling.email.TemplateEmailSender mTemplateEmailSender
protected atg.multisite.SiteManager mSiteManager
protected atg.web.messaging.MessageTools mMessageTools
protected java.lang.String mWalletHolderPath
protected java.lang.String mBasePromotionStatesPath
protected java.lang.String mWalletPromotionStatesPath
protected java.util.Map mDuplicateOrderExcludedOrderPropertiesMap
protected volatile boolean mMultiSiteEnabled
public atg.commerce.csr.promotion.PromotionWalletTools getPromotionWalletTools()
public void setPromotionWalletTools(atg.commerce.csr.promotion.PromotionWalletTools pPromotionWalletTools)
public atg.svc.agent.customer.CustomerProfileTools getCustomerProfileTools()
public void setCustomerProfileTools(atg.svc.agent.customer.CustomerProfileTools pCustomerProfileTools)
public atg.multisite.SiteContextManager getSiteContextManager()
public void setSiteContextManager(atg.multisite.SiteContextManager pSiteContextManager)
pSiteContextManager
- the siteContextManager to setpublic void setReturnTools(atg.commerce.csr.returns.ReturnTools pReturnTools)
pReturnTools
- the return toolspublic atg.commerce.csr.returns.ReturnTools getReturnTools()
public java.lang.String[] getPaymentGroupHighlightedStates()
public void setPaymentGroupHighlightedStates(java.lang.String[] pPaymentGroupHighlightedStates)
public java.lang.String[] getCommerceItemHighlightedStates()
public void setCommerceItemHighlightedStates(java.lang.String[] pCommerceItemHighlightedStates)
public java.lang.String[] getOrderHighlightedStates()
public void setOrderHighlightedStates(java.lang.String[] pOrderHighlightedStates)
public java.lang.String[] getShipItemRelationshipHighlightedStates()
public void setShipItemRelationshipHighlightedStates(java.lang.String[] pShipItemRelationshipHighlightedStates)
public java.lang.String[] getShippingGroupHighlightedStates()
public void setShippingGroupHighlightedStates(java.lang.String[] pShippingGroupHighlightedStates)
public void setDuplicateOrderExcludedProperties(java.util.Properties pDuplicateOrderExcludedProperties)
pDuplicateOrderExcludedProperties
- the value to set for property DuplicateOrderExcludedPropertiespublic java.util.Properties getDuplicateOrderExcludedProperties()
public atg.commerce.order.CommerceItemManager getCommerceItemManager()
public void setCommerceItemManager(atg.commerce.order.CommerceItemManager pCommerceItemManager)
public java.lang.String[] getShippingGroupShippedStates()
public void setShippingGroupShippedStates(java.lang.String[] pShippingGroupShippedStates)
public java.lang.String[] getNonModifiableOrderStates()
public void setNonModifiableOrderStates(java.lang.String[] pNonModifiableOrderStates)
public java.lang.String[] getNonModifiablePaymentGroupStates()
public void setNonModifiablePaymentGroupStates(java.lang.String[] pNonModifiablePaymentGroupStates)
public java.lang.String getSalePriceListPropertyName()
public void setSalePriceListPropertyName(java.lang.String pSalePriceListPropertyName)
public atg.commerce.pricing.PricingTools getPricingTools()
public void setPricingTools(atg.commerce.pricing.PricingTools pPricingTools)
public java.lang.String getTicketOrdersPropertyName()
public void setTicketOrdersPropertyName(java.lang.String pTicketOrdersPropertyName)
pTicketOrdersPropertyName
- public void setValidatePaymentGroupsChainId(java.lang.String pValidatePaymentGroupsChainId)
pValidatePaymentGroupsChainId
- a String
valuepublic java.lang.String getValidatePaymentGroupsChainId()
String
valuepublic CSREnvironmentTools getCSREnvironmentTools()
public void setCSREnvironmentTools(CSREnvironmentTools pCSREnvironmentTools)
public CSRCloneEditManager getCloneEditManager()
public void setCloneEditManager(CSRCloneEditManager pCloneEditManager)
public CSRAgentMessagingTools getCSRAgentMessagingTools()
public void setClaimableManager(atg.commerce.claimable.ClaimableManager pClaimableManager)
pClaimableManager
- a ClaimableManager
valuepublic atg.commerce.claimable.ClaimableManager getClaimableManager()
ClaimableManager
valuepublic void setIncompleteOrderStates(java.lang.String[] pIncompleteOrderStates)
pIncompleteOrderStates
- an array of order states that indicate that
an order is incompletepublic java.lang.String[] getIncompleteOrderStates()
public void setFulfilledOrderStates(java.lang.String[] pFulfilledOrderStates)
pFulfilledOrderStates
- an array of order states that indicate that
an order is fulfilledpublic java.lang.String[] getFulfilledOrderStates()
public void setSubmittedOrderStates(java.lang.String[] pSubmittedOrderStates)
pSubmittedOrderStates
- an array of order states that indicate that
an order is submittedpublic java.lang.String[] getSubmittedOrderStates()
public void setCloneEditOrderStates(java.lang.String[] pCloneEditOrderStates)
pCloneEditOrderStates
- array of order states that indicate that an order should use
clone editing when loaded for modificationspublic java.lang.String[] getCloneEditOrderStates()
public atg.commerce.promotion.PromotionTools getPromotionTools()
public void setPromotionTools(atg.commerce.promotion.PromotionTools pPromotionTools)
pPromotionTools
- The promotionTools to set.public void setUseRequestLocale(boolean pUseRequestLocale)
pUseRequestLocale
- a boolean
valuepublic boolean isUseRequestLocale()
boolean
valuepublic void setCommercePropertyManager(atg.commerce.profile.CommercePropertyManager pCommercePropertyManager)
pCommercePropertyManager
- the component that defines properties of the profile for Commercepublic atg.commerce.profile.CommercePropertyManager getCommercePropertyManager()
public void setCSRConfigurator(CSRConfigurator pCSRConfigurator)
pCSRConfigurator
- the CSRConfiguratorpublic CSRConfigurator getCSRConfigurator()
public void setDuplicateProfileProperties(java.lang.String[] pDuplicateProfileProperties)
pDuplicateProfileProperties
- the names of the profile properties to check when looking for
duplicated profiles.public java.lang.String[] getDuplicateProfileProperties()
public void setOrderCommentItemDescriptorName(java.lang.String pOrderCommentItemDescriptorName)
pOrderCommentItemDescriptorName
- the name of the "comment" item descriptor in the order repositorypublic java.lang.String getOrderCommentItemDescriptorName()
public void setOrderManager(atg.commerce.order.OrderManager pOrderManager)
pOrderManager
- the OrderManager component that will be used to create
a new, empty orderpublic atg.commerce.order.OrderManager getOrderManager()
public void setPriceListManager(atg.commerce.pricing.priceLists.PriceListManager pPriceListManager)
pPriceListManager
- the Price List Managerpublic atg.commerce.pricing.priceLists.PriceListManager getPriceListManager()
public void setPurchaseProcessHelper(atg.commerce.order.purchase.PurchaseProcessHelper pPurchaseProcessHelper)
pPurchaseProcessHelper
- a PurchaseProcessHelper
valuepublic atg.commerce.order.purchase.PurchaseProcessHelper getPurchaseProcessHelper()
PurchaseProcessHelper
valuepublic atg.userprofiling.PropertyManager getProfilePropertyManager()
public void setProfilePropertyManager(atg.userprofiling.PropertyManager pProfilePropertyManager)
pProfilePropertyManager
- The ProfilePropertyManager to setpublic boolean isPersistConfirmationEmails()
public void setPersistConfirmationEmails(boolean pPersistConfirmationEmails)
pPersistConfirmationEmails
- The PersistConfirmationEmails to setpublic boolean isSendEmailInSeparateThread()
public atg.nucleus.ServiceMap getConfirmationEmailMap()
public void setConfirmationEmailMap(atg.nucleus.ServiceMap pConfirmationEmailMap)
pConfirmationEmailMap
- The ConfirmationEmailMap to setpublic atg.userprofiling.email.TemplateEmailSender getTemplateEmailSender()
public void setTemplateEmailSender(atg.userprofiling.email.TemplateEmailSender pTemplateEmailSender)
pTemplateEmailSender
- The TemplateEmailSender to setpublic void setScenarioMessageDispatcher(atg.commerce.csr.scenario.MessageDispatcher pScenarioMessageDispatcher)
pScenarioMessageDispatcher
- component that will send the
initializeProfile eventpublic atg.commerce.csr.scenario.MessageDispatcher getScenarioMessageDispatcher()
public java.util.Map getCloneContactInfoExcludedProperties()
public void setCloneContactInfoExcludedProperties(java.util.Map pCloneContactInfoExcludedProperties)
pCloneContactInfoExcludedProperties
- The cloneContactInfoExcludedProperties to set.public java.util.Map getCloneContactInfoPropExceptions()
public void setCloneContactInfoPropExceptions(java.util.Map pCloneContactInfoPropExceptions)
pCloneContactInfoPropExceptions
- The cloneContactInfoPropExceptions to set.public boolean isAllowCloningContactInfo()
public void setAllowCloningContactInfo(boolean pAllowCloningContactInfo)
pAllowCloningContactInfo
- The allowCloningContactInfo to set.public boolean isPersistOrderForTransientUsers()
persistCurrentOrder()
public void setPersistOrderForTransientUsers(boolean pPersistOrderForTransientUsers)
pPersistOrderForTransientUsers
- persistCurrentOrder()
public atg.multisite.SiteManager getSiteManager()
public void setSiteManager(atg.multisite.SiteManager pSiteManager)
pSiteManager
- the siteManager to setpublic atg.web.messaging.MessageTools getMessageTools()
public void setMessageTools(atg.web.messaging.MessageTools pMessageTools)
public void setWalletHolderPath(java.lang.String pWalletHolderPath)
public java.lang.String getWalletHolderPath()
public void setBasePromotionStatesPath(java.lang.String pBasePromotionStatesPath)
public java.lang.String getBasePromotionStatesPath()
public void setWalletPromotionStatesPath(java.lang.String pWalletPromotionStatesPath)
public java.lang.String getWalletPromotionStatesPath()
public java.util.Map addPriceListParameter(java.util.Map pExtraParameters)
In Commerce, the price list passed in the with parameter map overrides the default behavior of using the order's owner's price list.
The price lists are added only if price lists are being used and there's not an entry already in the map.
pExtraParameters
- the extra parameters map in which to add the price list parameters. if null,
a new map is created.public java.util.Map addListPriceListParameter(java.util.Map pExtraParameters, atg.repository.RepositoryItem pListPriceList)
pExtraParameters
- pListPriceList
- public java.util.Map addSalePriceListParameter(java.util.Map pExtraParameters, atg.repository.RepositoryItem pSalePriceList)
pExtraParameters
- pSalePriceList
- public java.util.Map addCurrentOrderPricingParameters(java.util.Map pExtraParameters)
The implementation adds the price list parameters based on the active price lists. Also, if a return or exchange is in progress, the exchange order pricing parameters are added.
pExtraParameters
- addPriceListParameter(Map)
,
ReturnTools.addExchangeOrderPricingParameters(Map, ReturnRequest)
public java.util.Map addBypassPromotionVetoersParameter(java.util.Map pExtraParameters)
pExtraParameters
- PricingConstants.DISABLE_VETOING_PARAM
,
PricingTools.addBypassPromotionVetoersParameter(Map)
public java.util.Map addItemPriceSourceParameter(java.util.Map pExtraParameters, java.util.List pPricingOverrides)
pExtraParameters
- pPricingOverrides
- PricingTools.addItemPriceSourceParameter(Map, List)
public java.util.Map addCurrentTicketParameter(java.util.Map pExtraParameters)
pExtraParameters
- CSC_CURRENTTICKET_PIPELINE_PARAM
public java.util.Map addBypassPaymentGroupAuthorizationParameter(java.util.Map pExtraParameters)
PricingTools#addBypassExpiredPromotionsCheckParameter(Map)
public java.util.Map addBypassExpiredPromotionsCheckParameter(java.util.Map pExtraParameters)
PricingTools#addBypassExpiredPromotionsCheckParameter(Map)
public void addItemToCollection(atg.repository.RepositoryItem pItem, atg.repository.RepositoryItem pItemToAdd, java.lang.String pPropertyName) throws atg.repository.RepositoryException, atg.beans.PropertyNotFoundException
This method will get the item for update, add the item to the collection property and call updateItem.
The caller is responsible for demarcating transaction boundries.
pItem
- the item that contains the mappItemToAdd
- the item that will be added to the mappPropertyName
- the name of the property containing the mapRepositoryException,
- PropertyNotFoundExceptionatg.repository.RepositoryException
atg.beans.PropertyNotFoundException
public void addItemToMap(atg.repository.RepositoryItem pItem, atg.repository.RepositoryItem pItemToAdd, java.lang.Object pKey, java.lang.String pPropertyName) throws atg.repository.RepositoryException, atg.beans.PropertyNotFoundException
This method will get the item for update, add the map entry and call updateItem.
The caller is responsible for demarcating transaction boundries.
pItem
- the item that contains the mappItemToAdd
- the item that will be added to the mappKey
- the key to the item in the mappPropertyName
- the name of the property containing the mapRepositoryException,
- PropertyNotFoundExceptionatg.repository.RepositoryException
atg.beans.PropertyNotFoundException
public void addItemToProperty(atg.repository.RepositoryItem pItem, atg.repository.RepositoryItem pItemToSet, java.lang.String pPropertyName) throws atg.repository.RepositoryException, atg.beans.PropertyNotFoundException
This method will get the item for update, set the property to the new item and call updateItem.
The caller is responsible for demarcating transaction boundries.
pItem
- the item that contains a reference to the new item.pItemToSet
- the item that will be set on the propertypPropertyName
- the name of the property that should be modified.RepositoryException,
- PropertyNotFoundExceptionatg.repository.RepositoryException
atg.beans.PropertyNotFoundException
public void removeItemFromProperty(atg.repository.RepositoryItem pItem, java.lang.String pPropertyName) throws atg.repository.RepositoryException, atg.beans.PropertyNotFoundException
pItem
- pPropertyName
- atg.repository.RepositoryException
atg.beans.PropertyNotFoundException
public atg.repository.MutableRepositoryItem createNewAgentOrderCommentItem() throws atg.repository.RepositoryException
atg.repository.RepositoryException
public atg.repository.RepositoryItem createOrderComment(atg.commerce.order.Order pOrder, atg.repository.RepositoryItem pCustomerProfile, atg.repository.RepositoryItem pAgentProfile, java.lang.String pComment, java.lang.String pTicketId) throws atg.repository.RepositoryException
pOrder
- the order that will own the commentpComment
- the comment datapCustomerProfile
- the customer profile associated with the order.pAgentProfile
- the agent that made the comment.atg.repository.RepositoryException
public atg.repository.RepositoryItem findDuplicateUser(java.util.Dictionary pValues) throws atg.repository.RepositoryException
duplicatProfileProperties
property. The value for each property
is extracted from the dictionary and used to query the profile repository.pValues
- the dictionary of profile property valuesatg.repository.RepositoryException
public java.util.Collection findItemsNotInPriceList(java.util.Collection pCommerceItems, atg.repository.RepositoryItem pPriceList)
pCommerceItems
- pPriceList
- CSREnvironmentTools.findItemsNotInPriceList(Collection, RepositoryItem)
protected java.lang.Object getPropertyValue(java.util.Dictionary pValues, java.lang.String pName)
pValues
- the value dictionarypName
- the key to getpublic void removeItemFromCollection(atg.repository.RepositoryItem pItem, java.lang.String pPropertyName, atg.repository.RepositoryItem pRemoveItem) throws atg.repository.RepositoryException, atg.beans.PropertyNotFoundException
This method will get the item for update, remove the item from the collection and call updateItem.
The caller is responsible for demarcating transaction boundries.
pItem
- the item that contains the mappPropertyName
- the name of the collection propertypRemoveItem
- the item to remove from the collectionRepositoryException,
- PropertyNotFoundExceptionatg.repository.RepositoryException
atg.beans.PropertyNotFoundException
public void removeItemFromMap(atg.repository.RepositoryItem pItem, java.lang.String pPropertyName, java.lang.Object pKey) throws atg.repository.RepositoryException, atg.beans.PropertyNotFoundException
This method will get the item for update, remove the map entry and call updateItem.
The caller is responsible for demarcating transaction boundries.
pItem
- the item that contains the mappPropertyName
- the name of the property containing the mappKey
- the key to the item in the mapRepositoryException,
- PropertyNotFoundExceptionatg.repository.RepositoryException
atg.beans.PropertyNotFoundException
public void repriceOrder(java.lang.String pRepricingOperation, atg.commerce.order.Order pOrder, atg.commerce.pricing.PricingModelHolder pUserPricingModels, java.util.Locale pLocale, atg.repository.RepositoryItem pCustomerProfile, atg.repository.RepositoryItem pAgentProfile, java.util.Map pExtraParameters, atg.commerce.util.PipelineErrorHandler pErrorHandler) throws atg.commerce.CommerceException
If price lists are active, the agent's price list is used to reprice the order. However, this happens only if the price list is not already in the extra parameters map.
The caller is responsible for doing an update order and establishing transaction boundaries.
pRepricingOperation
- the pricing operator to performpOrder
- the order to repricepUserPricingModels
- the pricing models to use in repricingpLocale
- the agent display localepCustomerProfile
- the customer profile objectpAgentProfile
- the agent profilepExtraParameters
- extra parameters passed to the pricing operationpErrorHandler
- handler of pipeline errors.atg.commerce.CommerceException
addPriceListParameter(Map)
protected void setPropertiesOfOrderComment(atg.repository.MutableRepositoryItem pComment, java.lang.String pCommentData, java.util.Date pCreationDate, java.lang.String pOwnerId, atg.repository.RepositoryItem pAgent)
pComment
- the mutable comment itempCommentData
- the comment datapCreationDate
- the creation datepOwnerId
- the owner of the comment itempAgent
- the agent that created the commentpublic boolean validateCreditCardExpiration(java.lang.String pMonth, java.lang.String pYear)
pMonth
- the month of expirationpYear
- the year of expirationpublic boolean validateCreditCardNumber(java.lang.String pCreditCardNumber)
pCreditCardNumber
- public java.lang.String maskCreditCardNumber(java.lang.String pCreditCardNumber)
pCreditCardNumber
- the credit card number to maskNumberFormat.formatCreditCardNumber(String)
public void populateCustomerProfileFromAddress(atg.repository.RepositoryItem pProfile, atg.repository.RepositoryItem pAddress) throws atg.repository.RepositoryException
This implementation copies the first name and last name from the address.
pProfile
- the profile to populatepAddress
- the address from which to populateatg.repository.RepositoryException
public void setAddressFirstAndLastNameFromProfile(atg.repository.RepositoryItem pAddress, atg.repository.RepositoryItem pProfile) throws atg.repository.RepositoryException
The update occurs only if the values have not yet been set.
pAddress
- the address repository itempProfile
- the profileatg.repository.RepositoryException
public void initializeDefaultAddresses(atg.repository.RepositoryItem pProfile, java.lang.String pDefaultShippingAddressPropertyName, java.lang.String pDefaultBillingAddressPropertyName, boolean pCloneDefaultShippingForBilling) throws atg.repository.RepositoryException
The defaulShipping is cloned for the defaultBilling if the param pCloneDefaultShipping
is true.
If the default address isn't empty, and the first name and last name haven't been set, they are set to the profile's first and last name.
pProfile
- the affected profile.pDefaultShippingAddressPropertyName
- the name of the profile property containing the default shipping addresspDefaultBillingAddressPropertyName
- the name of the profile property containing the default billing addresspCloneDefaultShippingForBilling
- determines if the default shipping address is cloned for the default billing addressatg.repository.RepositoryException
getCloneDefaultShippingInfoExcludedProperties()
,
getCloneDefaultShippingInfoPropExceptions()
protected java.util.Map getCloneDefaultShippingInfoPropExceptions()
This method is used to determine the prop exceptions when cloning the defaultShippingAddress.
By default this method returns null. Extend this method to provide a map to the cloning process.
protected java.util.Map getCloneDefaultShippingInfoExcludedProperties()
This method is used to determine the excluded properties when cloning the defaultShippingAddress. By default this method returns null. Extend this method to provide a map to the cloning process.
public void addOrderPromotionsToHolder(atg.commerce.order.Order pOrder, atg.commerce.pricing.PricingModelHolder pPricingModelHolder)
pOrder
- pPricingModelHolder
- PromotionTools.getOrderPromotions(Order, Collection, Collection, Collection, Collection)
public boolean isOrderIncomplete(atg.commerce.order.Order pOrder)
incompleteOrderStates
property.pOrder
- public boolean isOrderIncomplete(atg.repository.RepositoryItem pOrderItem)
incompleteOrderStates
property.pOrderItem
- public boolean isOrderSubmitted(atg.commerce.order.Order pOrder)
submittedOrderStates
property.pOrder
- public boolean isOrderSubmitted(atg.repository.RepositoryItem pOrderItem)
submittedOrderStates
property.pOrderItem
- public boolean isOrderFulfilled(atg.repository.RepositoryItem pOrderItem)
fulfilledOrderStates
property.pOrderItem
- ReturnTools.isOrderFulfilled(RepositoryItem)
public boolean isOrderFulfilled(atg.commerce.order.Order pOrder)
fulfilledOrderStates
property.pOrderItem
- ReturnTools.isOrderFulfilled(Order)
protected boolean isFulfilledOrderState(java.lang.String pState)
fulfilledOrderStates
property.pState
- ReturnTools.isFulfilledOrderState(String)
public boolean isCloneEditState(atg.commerce.order.Order pOrder)
pOrder
- public boolean isCloneEditState()
public boolean isOrderInModifiableState(atg.commerce.order.Order pOrder)
public boolean isPaymentGroupInModifiableState(atg.commerce.order.PaymentGroup pPaymentGroup)
public boolean isOrderModifiable(atg.commerce.order.Order pOrder)
Returns false if any items are considered shipped as determined by
the areAnyItemsShipped
method.
Returns false if any payment groups are in a non-modifiable state as determined
by the isPaymentGroupInModifiableState
method
Returns false if the Order is not is a modifiable state as determined
by the isOrderInModifiableState
method.
Returns false if the Order is related to any returns.
pOrder
- areAnyItemsShipped(Order)
,
isPaymentGroupInModifiableState(PaymentGroup)
,
isOrderInModifiableState(Order)
,
isOrderSupportedforUpdate(Object)
public boolean isOrderSupportedforUpdate(java.lang.Object pOrder)
pOrder
- CSRConfigurator.supportedPayemntGroupTypes
public boolean areAnyItemsShipped(atg.commerce.order.Order pOrder)
ShippingGroupCommerceItemRelationship
in
the Order has a state of "DELIVERED"pOrder
- public boolean areAllGroupsShipped(atg.commerce.order.Order pOrder, java.lang.String[] pShippingGroupShippedStates)
ShippingGroup
s in
the Order are in a "shipped".pOrder
- pShippingGroupShippedStates
- optional. the states used to compare the shipping group
states. If null, the states configured by the shippingGroupShippedStates
property are
used.public void claimCouponForSubmittedOrder(atg.commerce.order.edit.CloneEditState pCloneEditState, java.lang.String pClaimCode, atg.commerce.order.Order pOrder, atg.repository.RepositoryItem pCustomerProfile, atg.repository.RepositoryItem pAgentProfile, SubmittedOrderPricingModelHolder pSubmittedOrderPricingModelHolder, java.lang.String pRepricingOperation, java.util.Locale pUserLocale, java.util.Map pExtraParametersMap) throws atg.repository.RepositoryException, atg.commerce.claimable.ClaimableException, atg.commerce.promotion.PromotionException, atg.commerce.CommerceException
The coupon is claimed, the promotions are granted, and the promotion is added to the pricing model holder.
pClaimCode
- the claim code for the couponpOrder
- the submitted order that the coupon is being claimed forpCustomerProfile
- the customer profile itempAgentProfile
- the agent profile itempSubmittedOrderPricingModelHolder
- the pricing model holder that is used for repricing the orderpRepricingOperation
- the pricing operation used to reprice the order.pUserLocale
- the user localepExtraParametersMap
- the extra parameters map passed to the repricing operationatg.repository.RepositoryException
atg.commerce.claimable.ClaimableException
atg.commerce.promotion.PromotionException
atg.commerce.CommerceException
public boolean persistCurrentOrder() throws atg.commerce.CommerceException
If the active customer is transient, the order is saved depending on the configuration
of the persistOrderForTransientUsers
property.
atg.repository.RepositoryException
atg.commerce.CommerceException
public java.util.Locale convertLocale(java.lang.Object pLocale)
pLocale
- public java.util.Locale getActiveCustomerPricingLocale()
PricingTools.getPricingLocale(RepositoryItem, String, boolean, Map, Locale)
public java.util.Locale getActiveCustomerDisplayLocale()
EnvironmentTools.getActiveCustomerDisplayLocale()
public java.lang.String getActiveCustomerCurrencyCode()
public java.text.DecimalFormatSymbols getActiveCustomerDecimalFormatSymbols()
PricingTools.getDefaultLocale()
public void claimCoupon(java.lang.String pClaimCode, java.lang.String pPostClaimPricingOperation, java.util.Map pRepriceParameterMap) throws atg.commerce.claimable.ClaimableException, atg.commerce.CommerceException, atg.repository.RepositoryException
pClaimCode
- the coupon claim codepPostClaimPricingOperation
- pRepriceParameterMap
- atg.commerce.claimable.ClaimableException
atg.commerce.CommerceException
atg.repository.RepositoryException
ClaimableManager.claimCoupon(String, String)
,
claimCouponForSubmittedOrder(CloneEditState, String, Order, RepositoryItem, RepositoryItem, SubmittedOrderPricingModelHolder, String, Locale, Map)
public void copyContactInfoToCreditCard(atg.core.util.Address pExistingAddress, atg.commerce.order.CreditCard pCreditCard) throws atg.commerce.CommerceException
atg.commerce.CommerceException
public void copyContactInfoToCreditCard(atg.repository.RepositoryItem pExistingAddress, atg.commerce.order.CreditCard pCreditCard) throws atg.commerce.CommerceException
atg.commerce.CommerceException
public boolean sendAutomaticConfirmation(ConfirmationInfo pConfirmationInfo) throws atg.userprofiling.email.TemplateEmailException
If successful, this method will set the autoEmailSent
and autoConfirmationEmailAddress
properties of the confirmation info object.
pConfirmationInfo
- atg.userprofiling.email.TemplateEmailException
public boolean sendAutomaticConfirmation(atg.commerce.order.Order pOrder, atg.repository.RepositoryItem pProfile) throws atg.userprofiling.email.TemplateEmailException
atg.userprofiling.email.TemplateEmailException
sendAutomaticConfirmation(ConfirmationInfo)
public void sendConfirmationEmail(atg.commerce.order.Order pOrder, atg.repository.RepositoryItem pProfile, java.lang.String pToAddress) throws atg.userprofiling.email.TemplateEmailException
atg.userprofiling.email.TemplateEmailException
sendConfirmationEmail(ConfirmationInfo)
public void sendConfirmationEmail(ConfirmationInfo pConfirmationInfo) throws atg.userprofiling.email.TemplateEmailException
pConfirmationInfo
- contains the required info for sending the confirmation. This object
is also available from within the template.atg.userprofiling.email.TemplateEmailException
public java.util.Map generateConfirmationTemplateDefaultParams(atg.commerce.order.Order pOrder, atg.repository.RepositoryItem pProfile)
pOrder
- - an orderpProfile
- - a customer profilegenerateConfirmationTemplateDefaultParams(ConfirmationInfo)
public java.util.Map generateConfirmationTemplateDefaultParams(ConfirmationInfo pConfirmationInfo)
CONFIRMATIONEMAIL_PARAM_NAME
public java.lang.String getConfirmationTemplateToUse()
public void setConfirmationTemplateToUse(java.lang.String pTemplateToUse)
pTemplateToUse
- - the Email Template name.public atg.commerce.csr.returns.ReturnRequest getCurrentReturnRequest()
public atg.progressbar.ProgressBarItem getProgressBar(java.lang.String pPath)
public atg.repository.RepositoryItem getClaimableItem(java.lang.String pId) throws atg.repository.RepositoryException
atg.repository.RepositoryException
public atg.payment.creditcard.CreditCardInfo createCreditCardInfo(atg.repository.RepositoryItem pCreditCard) throws atg.repository.RepositoryException, java.beans.IntrospectionException
atg.repository.RepositoryException
java.beans.IntrospectionException
public java.util.List collectUniqueExistingAddresses(atg.commerce.order.purchase.ShippingGroupMapContainer pShippingGroupMapContainer, atg.commerce.order.purchase.PaymentGroupMapContainer pPaymentGroupMapContainer, atg.commerce.order.Order pOrder)
pOrder
- public void removeDeletedShippingGroups(atg.commerce.order.purchase.ShippingGroupMapContainer pShippingGroupMapContainer, java.util.List pRemovedEntries)
pShippingGroupMapContainer
- pRemovedEntries
- public void removeDeletedPaymentGroups(atg.commerce.order.purchase.PaymentGroupMapContainer pPaymentGroupMapContainer, java.util.List pRemovedEntries)
pPaymentGroupMapContainer
- pRemovedEntries
- public int findMatchingAddress(java.lang.Object pAddress, java.util.List pAddressList)
pAddress
- public void findPropertyChanges(java.lang.Object pNewValues, java.lang.Object pOldValues, java.lang.String[] pPropertyNames, java.util.List pUpdates) throws javax.servlet.ServletException
pNewValues
- pOldValues
- pPropertyNames
- pUpdates
- javax.servlet.ServletException
public boolean associateTicketAndOrder(java.lang.String pOrderId, atg.repository.MutableRepositoryItem pTicket) throws atg.ticketing.TicketingException
pOrderId
- -- The order that need to be associated with a ticket.pTicket
- -- This is optional property. If this parameter is null, then current active ticket is taken from the
EnvironmentToolsatg.ticketing.TicketingException
EnvironmentTools.getActiveTicket()
public void overrideItemPrice(atg.commerce.order.CommerceItem pItem, double pNewAmount, atg.commerce.order.Order pOrder, java.util.Locale pUserLocale, java.lang.String pTicketId) throws atg.commerce.CommerceException
This method will clear the PricingAdjustments for the item and add a new one that details the overridden price
The item detail price infos are also cleared and a new one is created for the entire range of the item and the new price.
An audit event is also generated that details the change.
pItem
- item to be overriddenpNewAmount
- the new amountpOrder
- the affected orderpUserLocale
- pTicketId
- atg.commerce.CommerceException
public void recreateInitialDetailsForItemsMarkedAsFinal(atg.commerce.order.Order pOrder, java.util.Locale pUserLocale, atg.repository.RepositoryItem pProfile) throws atg.commerce.CommerceException
Normally pricing will regenerate the details for every pricing operation. However, this process is skipped by the pricing engine for items marked as final. This method provides a way to force them to be regenerated base on the current price and the shipping group relationships.
pOrder
- pUserLocale
- pProfile
- atg.commerce.CommerceException
recreateInitialDetailsForItemMarkedAsFinal(CommerceItem, double, Locale, RepositoryItem, String)
public void recreateInitialDetailsForItemMarkedAsFinal(atg.commerce.order.CommerceItem pItem, double pAmount, java.util.Locale pUserLocale, atg.repository.RepositoryItem pProfile, java.lang.String pDescription) throws atg.commerce.CommerceException
Normally pricing will regenerate the details for every pricing operation. However, this process is skipped by the pricing engine for items marked as final. This method provides a way to force them to be regenerated based on the current price and the shipping group relationships.
atg.commerce.CommerceException
PricingTools.recreateInitialDetailsForItemMarkedAsFinal(CommerceItem, double, Locale, RepositoryItem, String)
public void overrideShippingPrice(atg.commerce.order.ShippingGroup pShippingGroup, double pNewAmount, atg.commerce.order.Order pOrder, java.util.Locale pUserLocale, java.lang.String pTicketId)
This method will clear the PricingAdjustments for the shipping group and add a new one that details the overridden price
An audit event is also generated that details the change.
pShippingGroup
- pNewAmount
- pOrder
- pUserLocale
- pTicketId
- protected void overridePriceInfoAmount(atg.commerce.pricing.AmountInfo pAmountInfo, double pNewAmount, double pTotalAdjustment, long pQuantity, java.lang.String pReasonDescription)
pAmountInfo
- pNewAmount
- pTotalAdjustment
- pQuantity
- pReasonDescription
- public boolean isAgentOverridePrice(atg.commerce.order.CommerceItem pItem)
pItem
- public java.util.List getAgentOverrideDetails(atg.commerce.order.CommerceItem pItem)
pItem
- public atg.commerce.pricing.PricingAdjustment getAgentOverrideDetail(atg.commerce.order.CommerceItem pItem)
pItem
- public double getTotalPriceOverrideAppeasementValue(atg.commerce.order.Order pOrder)
This method only returns the credit value. If the price overrides total to a debit, 0.0 will be returned.
pOrder
- public double getTotalPriceOverrideValue(atg.commerce.order.Order pOrder)
pOrder
- public boolean arePriceOverrides(atg.commerce.order.Order pOrder)
pOrder
- public boolean isOrderAdjusted(atg.commerce.order.Order pOrder)
pOrder
- public double getTotalManualAppeasementValue(atg.commerce.order.Order pOrder)
pOrder
- public double getTotalManualAdjustmentValue(atg.commerce.order.Order pOrder)
pOrder
- public double getTotalAppeasementValue(atg.commerce.order.Order pOrder)
pOrder
- protected java.util.Map createDuplicateOrderPropExceptionsMap()
This method returns null by default
public java.util.Map getDuplicateOrderExcludedOrderPropertiesMap()
duplicateOrderExcludedProperties
property.public static java.util.Collection parseString(java.lang.String pString)
public atg.commerce.order.Order duplicateOrder(java.lang.String pOrderId, java.util.Map pPropExceptions, java.util.Map pExcludedProperties) throws atg.commerce.CommerceException
pOrderId
- the order to duplicatepPropExceptions
- the property exceptions used when cloning the order repository itempExcludedProperties
- the exceluded property map used when cloning the order repository itematg.commerce.CommerceException
RepositoryUtils.cloneItem(RepositoryItem, boolean, Map, Map, MutableRepository, String)
protected void resetHandlingInstructionReferences(atg.repository.RepositoryItem pOriginalOrder, atg.repository.RepositoryItem pCloneOrder) throws atg.repository.RepositoryException
This method is called after duplicating an order into a clone copy.
pOriginalOrder
- pCloneOrder
- atg.repository.RepositoryException
protected void resetReturnInfoForCopy(atg.commerce.order.Order pOrder)
pOrder
- public boolean isTransactionMarkedAsRollBack()
public void ensureOrderAmountRemainingType(atg.commerce.order.purchase.CommerceIdentifierPaymentInfoContainer pCommerceIdentifierPaymentInfoContainer, atg.commerce.order.purchase.PaymentGroupMapContainer pPaymentGroupMapContainer)
pCommerceIdentifierPaymentInfoContainer
- pPaymentGroupMapContainer
- public boolean isHighlightedState(java.lang.Object pCommerceObject)
pCommerceObject
- public double getRemainingAmount(atg.repository.RepositoryItem pClaimable) throws atg.repository.RepositoryException
The maximum amount is computed as follows:
false
), pClaimable
- the claimable itematg.repository.RepositoryException
ClaimableTools.getRemainingAmount(RepositoryItem)
public boolean isMultiSiteEnabled()
SiteManager.isMultisiteEnabled()
check returns false, then the multi site is not supported.SiteManager.getActiveSitesByType(String)
.
If there is any active commerce site, then method returns true. The above logic is executed only once and the value is preserved to improve the performance.
CSRConfigurator.getCommerceSiteType()
,
SiteManager.getActiveSitesByType(String)
,
SiteManager.isMultisiteEnabled()
public java.lang.String getAgentDefaultSiteId()
This method just returns the CSRConfigurator#getDefaultSiteId() configured value.
CSRConfigurator.getDefaultSiteId()
public java.util.Collection<atg.repository.RepositoryItem> getSiteCatalogs(java.lang.String[] pSiteIds, atg.repository.RepositoryItem pProfile) throws atg.svc.agent.environment.EnvironmentException, atg.multisite.SiteContextException
This method loops through pSiteIds
and converts to a site object and calls
getSiteCatalogs(Collection, RepositoryItem)
.
pSiteIds
- pProfile
- atg.svc.agent.environment.EnvironmentException
atg.multisite.SiteContextException
getSiteCatalogs(Collection, RepositoryItem)
public java.util.Collection<atg.repository.RepositoryItem> getSiteCatalogs(java.util.Collection<atg.multisite.Site> pSites, atg.repository.RepositoryItem pProfile) throws atg.svc.agent.environment.EnvironmentException, atg.multisite.SiteContextException
This method loops through sites and performs the above steps and resultant catalog data is returned.
pSites
- pProfile
- atg.svc.agent.environment.EnvironmentException
atg.multisite.SiteContextException
isMultiSiteEnabled()
,
getSiteCatalog(Site, RepositoryItem)
public atg.repository.RepositoryItem getSiteCatalog(atg.multisite.Site pSite, atg.repository.RepositoryItem pProfile) throws atg.svc.agent.environment.EnvironmentException, atg.multisite.SiteContextException
First this method calls CSREnvironmentTools.getCatalogFromCallState(String)
to find out
if there is no explicit catalog for a site. If there is no explict catalog,
then it calls CSREnvironmentTools.getUsersCatalog(RepositoryItem, Site)
to get the catalog
for the site.
pSite
- pProfile
- atg.svc.agent.environment.EnvironmentException
atg.multisite.SiteContextException
isMultiSiteEnabled()
,
CSREnvironmentTools.getUsersCatalog(RepositoryItem, Site)
,
CSREnvironmentTools.getCatalogFromCallState(String)
,
CallState.isCallActive()
public java.util.Map createPromotionValueMap(atg.commerce.order.Order pOrder, boolean pIncludeOrderPromos, boolean pIncludeItemPromos, boolean pIncludeShippingPromos, boolean pIncludeTaxPromos)
pOrder
- pIncludeOrderPromos
- if true, the order promotions are included in the MappIncludeItemPromos
- if true, the item promotions are included in the MappIncludeShippingPromos
- if true, the shipping promotions are included in the MappIncludeTaxPromos
- if true, the tax promotions are included in the MapPromotionTools.createPromotionValueMap(Order, boolean, boolean, boolean, boolean)
public boolean isPriceListSameCurrencyAsOrder(atg.commerce.order.Order pOrder, atg.repository.RepositoryItem pPricelist)
pOrder
- pPricelist
- public java.lang.String getCurrencyForPriceList(atg.repository.RepositoryItem pPricelist)
pPricelist
- public void populateAnonymousCustomerProfileFromOrder(atg.repository.RepositoryItem pProfile, atg.commerce.order.Order pOrder) throws atg.repository.RepositoryException
pProfile
- pOrder
- atg.repository.RepositoryException
populateAnonymousCustomerProfileFromOrder(RepositoryItem, RepositoryItem)
public void populateAnonymousCustomerProfileFromOrder(atg.repository.RepositoryItem pProfile, atg.repository.RepositoryItem pOrder) throws atg.repository.RepositoryException
This implementation sets the first, middle and last name of the profile from the first credit card payment group on the order. It only doesn't this is the profile's properties are not already valued.
pProfile
- pOrder
- atg.repository.RepositoryException
public java.lang.Double parseAmount(java.lang.String pAmount, java.lang.String pCurrencyCode) throws java.text.ParseException
pAmount
- pCurrencyCode
- java.text.ParseException
public java.lang.String formatAmount(double pAmount, java.lang.String pCurrencyCode)
pAmount
- pCurrencyCode
- 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 getCurrentOrderCurrencySymbolInFormattingLocale()
if the order's currency code is null, then the currency code is obtained from the
getActiveCustomerCurrencyCode()
and this currency code is used to obtain the
currency symbol.
CSREnvironmentTools.getCurrentOrder()
,
LocaleTools.getUserFormattingLocaleHelper()
,
getActiveCustomerCurrencyCode()
public java.lang.String getPricingToolsDefaultCurrencySymbolInFormattingLocale()
PricingTools.getDefaultLocale()
and then returns
the currency symbol in the user's formatting locale.
PricingTools.getDefaultLocale()
,
LocaleTools.getUserFormattingLocaleHelper()