public class OrderTools extends GenericService
OrderManager
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
OrderTools()
Constructs an OrderTools object.
|
Modifier and Type | Method and Description |
---|---|
java.util.Map |
addAllowPartialInStorePayment(java.util.Map pExtraParameters)
Adds the parameter that will cause the processor that checks for the amount allocated
to InStorePayment to allow partial payment of InStorePickupShippingGroup.
|
java.util.Map |
addBypassExpiredPromotionsCheckParameter(java.util.Map pExtraParameters)
Adds the parameter that will cause the processor that checks for expired promotions
to bypass its processing.
|
java.util.Map |
addBypassPaymentGroupAuthorizationParameter(java.util.Map pExtraParameters)
Adds the parameter that will cause the processor that authorizes payment
groups to bypass its processing.
|
protected void |
addManualAdjustment(Order pOrder,
RepositoryItem pAdjustment)
This method adds the manual adjustment to the order.
|
void |
addManualAdjustment(Order pOrder,
RepositoryItem pAdjustment,
int pIndex)
Adds an adjustment at a specific index in the List.
|
void |
addQuoteInfo(Order pOrder,
RepositoryItem pQuoteInfo)
This method adds the given quote info repository item to the order.
|
int[] |
convertStateStringsToInts(java.lang.String[] pStateStrings)
Convert an array of states as strings to states as ints
|
static void |
copyAddress(Address pSrcAddress,
Address pDestAddress)
This method, given two atg.core.util.Address or atg.core.util.ContactInfo
objects, will copy the address information from the source to the destination object.
|
static void |
copyAddress(Address pAddress,
RepositoryItem pProfileAddress)
This method, given a Profile object and an atg.core.util.Address or atg.core.util.ContactInfo
object, will copy the address information from the Address or ContactInfo object to the profile.
|
static void |
copyAddress(RepositoryItem pProfileAddress,
Address pAddress)
This method, given a ContactInfo iten descriptor and an atg.core.util.Address or atg.core.util.ContactInfo
object, will copy the address information from the profile to the Address or ContactInfo object.
|
CommerceItem |
createCommerceItem(java.lang.String pType)
Returns a new instance of a CommerceItem whose class is mapped to the type supplied in pType.
|
CostCenter |
createCostCenter(java.lang.String pType)
Returns a new instance of a CostCenter whose class is mapped to the type supplied in
pType.
|
HandlingInstruction |
createHandlingInstruction(java.lang.String pType)
Returns a new instance of a HandlingInstruction whose class is mapped to the type supplied in
pType.
|
protected MutableRepositoryItem |
createManualAdjustmentItem(java.lang.String pItemType,
double pAmount,
java.lang.String pAdjustmentType,
java.lang.String pNotes,
java.lang.String pReasonCode)
Creates and returns a mutable, transient manual adjustment repository item
of the specified type.
|
Order |
createOrder(java.lang.String pType)
Returns a new instance of an Order whose class is mapped to the type supplied in pType.
|
Order |
createOrder(java.lang.String pType,
ShippingPriceInfo pShippingPriceInfo)
Returns a new instance of an Order whose class is mapped to the type supplied in pType.
|
Order |
createOrder(java.lang.String pType,
java.lang.String pOrderId)
Returns a new instance of an Order whose class is mapped to the type supplied in pType and
whose id will be that which is supplied in pOrderId.
|
Order |
createOrder(java.lang.String pType,
java.lang.String pOrderId,
ShippingPriceInfo pShippingPriceInfo)
Returns a new instance of an Order whose class is mapped to the type supplied in pType and
whose id will be that which is supplied in pOrderId.
|
RepositoryItem |
createOrderFixedAmountAdjustment(Order pOrder,
double pAmount,
java.lang.String pAdjustmentType,
java.lang.String pNotes,
java.lang.String pReasonCode)
Creates a new fixed amount manual adjustment and adds it to the order.
|
PaymentGroup |
createPaymentGroup(java.lang.String pType)
Returns a new instance of a PaymentGroup whose class is mapped to the type supplied in
pType.
|
MutableRepositoryItem |
createQuoteInfoItem(java.lang.String pItemType)
Creates and returns a mutable, transient quote info repository item
|
Relationship |
createRelationship(java.lang.String pType)
Returns a new instance of a Relationship whose class is mapped to the type supplied in
pType.
|
ShippingGroup |
createShippingGroup(java.lang.String pType)
Returns a new instance of a ShippingGroup whose class is mapped to the type supplied in
pType.
|
ShippingGroup |
createShippingGroup(java.lang.String pType,
ShippingPriceInfo pShippingPriceInfo)
Returns a new instance of a ShippingGroup whose class is mapped to the type supplied in
pType.
|
boolean |
deleteManualAdjustment(Order pOrder,
java.lang.String pAdjustmentItemId)
Deletes manual adjustments from the order's list of adjustments.
|
void |
doStartService()
Start the OrderTools component.
|
java.util.Collection |
findShippingGroupsWithAddress(Order pOrder,
Address pAddress,
java.lang.String[] pPropertyNamesToCompare)
Finds all hardgood shipping group in the order with a matching address
|
java.util.Properties |
getBeanNameToItemDescriptorMap()
Returns the beanNameToItemDescriptorMap
|
CatalogTools |
getCatalogTools()
Returns the catalogTools
|
java.util.Properties |
getCommerceItemTypeClassMap()
returns a java.util.Properties object of the type to classname map for Item classes.
|
java.util.Properties |
getCostCenterTypeClassMap()
returns a java.util.Properties object of the type to classname map for CostCenter classes.
|
boolean |
getCreateDefaultCostCenter()
Returns property createDefaultCostCenter
|
boolean |
getCreateDefaultPaymentGroup()
Returns property createDefaultPaymentGroup
|
boolean |
getCreateDefaultShippingGroup()
Returns property createDefaultShippingGroup
|
java.lang.String |
getDefaultCommerceItemType()
Returns the defaultCommerceItemType
|
java.lang.String |
getDefaultCostCenterType()
Returns the defaultCostCenterType
|
java.lang.String |
getDefaultHandlingInstructionType()
Returns the defaultHandlingInstructionType
|
java.lang.Class |
getDefaultItemPriceInfoClass()
Returns property defaultItemPriceInfoClass
|
java.lang.Class |
getDefaultOrderPriceInfoClass()
Returns property defaultOrderPriceInfoClass
|
java.lang.String |
getDefaultOrderType()
Returns the defaultOrderType
|
java.lang.String |
getDefaultPaymentGroupAddressType()
Returns property defaultPaymentGroupAddressType
|
java.lang.String |
getDefaultPaymentGroupType()
Returns the defaultPaymentGroupType
|
java.lang.String |
getDefaultProfileType()
Returns the defaultProfileType
|
java.lang.String |
getDefaultShippingGroupAddressType()
Returns property defaultShippingGroupAddressType
|
java.lang.String |
getDefaultShippingGroupType()
Returns the defaultShippingGroupType
|
java.lang.Class |
getDefaultShippingPriceInfoClass()
Returns property defaultShippingPriceInfoClass
|
java.lang.Class |
getDefaultTaxPriceInfoClass()
Returns property defaultTaxPriceInfoClass
|
GiftlistManager |
getGiftlistManager()
Returns the giftlistManager
|
java.util.Properties |
getHandlingTypeClassMap()
returns a java.util.Properties object of the type to classname map for HandlingInstruction classes.
|
InventoryManager |
getInventoryManager()
Returns the InventoryManager
|
java.lang.String |
getItemDescriptorForCommerceItemType(java.lang.String pCommerceItemType)
Return the item descriptor used for a specified commerce item type.
|
java.lang.String |
getItemDescriptorForOrderType(java.lang.String pOrderType)
Return the item descriptor used for a specified order type.
|
java.lang.String |
getItemDescriptorForPaymentType(java.lang.String pPaymentType)
Return the item descriptor used for a specified payment group type.
|
java.lang.String |
getItemDescriptorForShippingType(java.lang.String pShippingType)
Return the item descriptor used for a specified shipping group type.
|
java.util.Properties |
getItemDescriptorToBeanNameMap()
Returns the itemDescriptorToBeanNameMap
|
java.lang.String |
getMappedBeanName(java.lang.String pRepItemName)
Returns the bean name mapped to the repository item name.
|
java.lang.String |
getMappedItemDescriptorName(java.lang.String pBeanName)
Returns the repository item name mapped to the bean name.
|
java.lang.String |
getOrderFixedAmountAdjustmentType()
Returns the OrderFixedAmountAdjustmentType
|
java.lang.String |
getOrderItemDescriptorName()
Returns the OrderItemDescriptorName
|
atg.commerce.order.OrderLookupService |
getOrderLookupService()
The service that is actually used to find the desired orders
|
Repository |
getOrderRepository()
Returns the orderRepository
|
java.util.Properties |
getOrderTypeClassMap()
returns a java.util.Properties object of the type to classname map for Order classes.
|
java.util.Properties |
getPaymentGroupBillingAddressClassNameMap()
Returns property paymentGroupBillingAddressClassNameMap
|
java.util.Properties |
getPaymentTypeClassMap()
returns a java.util.Properties object of the type to classname map for PaymentGroup classes.
|
PipelineManager |
getPipelineManager()
Returns the pipelineManager
|
Repository |
getProfileRepository()
Returns the profileRepository
|
CommerceProfileTools |
getProfileTools()
Returns the profileTools
|
java.lang.String |
getQuoteInfoItemDescriptorName()
Returns the QuoteInfoItemDescriptorName
|
java.util.Properties |
getRelationshipTypeClassMap()
returns a java.util.Properties object of the type to classname map for Relationship classes.
|
java.util.Properties |
getShippingGroupShippingAddressClassNameMap()
Returns property shippingGroupShippingAddressClassNameMap
|
java.util.Properties |
getShippingTypeClassMap()
returns a java.util.Properties object of the type to classname map for ShippingGroup classes.
|
javax.transaction.TransactionManager |
getTransactionManager()
The service used to manage all transactions
|
void |
initializeRelationship(Order pOrder,
CostCenterCommerceItemRelationship pRelationship,
java.lang.String pCostCenterId,
java.lang.String pCommerceItemId)
This method initializes the Relationship to contain a CostCenter and a CommerceItem.
|
void |
initializeRelationship(Order pOrder,
CostCenterOrderRelationship pRelationship,
java.lang.String pCostCenterId)
This method initializes the Relationship to contain a CostCenter and an Order.
|
void |
initializeRelationship(Order pOrder,
CostCenterShippingGroupRelationship pRelationship,
java.lang.String pCostCenterId,
java.lang.String pShippingGroupId)
This method initializes the Relationship to contain a CostCenter and a ShippingGroup.
|
void |
initializeRelationship(Order pOrder,
PaymentGroupCommerceItemRelationship pRelationship,
java.lang.String pPaymentGroupId,
java.lang.String pCommerceItemId)
This method initializes the Relationship to contain a PaymentGroup and a CommerceItem.
|
void |
initializeRelationship(Order pOrder,
PaymentGroupOrderRelationship pRelationship,
java.lang.String pPaymentGroupId)
This method initializes the Relationship to contain a PaymentGroup and an Order.
|
void |
initializeRelationship(Order pOrder,
PaymentGroupShippingGroupRelationship pRelationship,
java.lang.String pPaymentGroupId,
java.lang.String pShippingGroupId)
This method initializes the Relationship to contain a PaymentGroup and a ShippingGroup.
|
void |
initializeRelationship(Order pOrder,
ShippingGroupCommerceItemRelationship pRelationship,
java.lang.String pShippingGroupId,
java.lang.String pCommerceItemId)
This method initializes the Relationship to contain a ShippingGroup and a CommerceItem.
|
protected java.util.Properties |
invertBeanToItemMap(java.util.Properties pBeanToItemMap)
Invert the key/value pairs in
pBeanToItemMap and return
a new Properties object containing the inverted map. |
boolean |
isAssignCatalogInCommerceItem()
If this is true, then newly created commerce items will have the
'catalogId' property automatically populated with the catalog for
the current user
The default is false.
|
protected boolean |
isNullAddress(Address pAddress)
Query whether an Address object is null or empty.
|
protected boolean |
isNullCreditCard(CreditCard pCreditCard)
Query whether a CreditCard object is null or empty.
|
boolean |
isOrderState(Order pOrder,
java.lang.String[] pStates)
Determines if an order is in one of the provided states
|
void |
registerSynchronization(Order pOrder)
Registers the given order as a synchronization on the current
transaction.
|
void |
setAssignCatalogInCommerceItem(boolean pAssignCatalogInCommerceItem) |
void |
setBeanNameToItemDescriptorMap(java.util.Properties pBeanNameToItemDescriptorMap)
Sets the beanNameToItemDescriptorMap
|
void |
setCatalogTools(CatalogTools pCatalogTools)
Sets the catalogTools
|
void |
setCommerceItemTypeClassMap(java.util.Properties pProp)
sets a java.util.Properties object to contain the type to classname map for Items.
|
void |
setCostCenterTypeClassMap(java.util.Properties pProp)
sets a java.util.Properties object to contain the type to classname map for CostCenters.
|
void |
setCreateDefaultCostCenter(boolean pCreateDefaultCostCenter)
Sets property createDefaultCostCenter
|
void |
setCreateDefaultPaymentGroup(boolean pCreateDefaultPaymentGroup)
Sets property createDefaultPaymentGroup
|
void |
setCreateDefaultShippingGroup(boolean pCreateDefaultShippingGroup)
Sets property createDefaultShippingGroup
|
void |
setDefaultCommerceItemType(java.lang.String pDefaultCommerceItemType)
Sets the defaultCommerceItemType
|
void |
setDefaultCostCenterType(java.lang.String pDefaultCostCenterType)
Sets the defaultCostCenterType
|
void |
setDefaultHandlingInstructionType(java.lang.String pDefaultHandlingInstructionType)
Sets the defaultHandlingInstructionType
|
void |
setDefaultItemPriceInfoClass(java.lang.Class pDefaultItemPriceInfoClass)
Sets property defaultItemPriceInfoClass
|
void |
setDefaultOrderPriceInfoClass(java.lang.Class pDefaultOrderPriceInfoClass)
Sets property defaultOrderPriceInfoClass
|
void |
setDefaultOrderType(java.lang.String pDefaultOrderType)
Sets the defaultOrderType
|
void |
setDefaultPaymentGroupAddressType(java.lang.String pDefaultPaymentGroupAddressType)
Sets property defaultPaymentGroupAddressType
|
void |
setDefaultPaymentGroupType(java.lang.String pDefaultPaymentGroupType)
Sets the defaultPaymentGroupType
|
void |
setDefaultProfileType(java.lang.String pDefaultProfileType)
Sets the defaultProfileType
|
void |
setDefaultShippingGroupAddressType(java.lang.String pDefaultShippingGroupAddressType)
Sets property defaultShippingGroupAddressType
|
void |
setDefaultShippingGroupType(java.lang.String pDefaultShippingGroupType)
Sets the defaultShippingGroupType
|
void |
setDefaultShippingPriceInfoClass(java.lang.Class pDefaultShippingPriceInfoClass)
Sets property defaultShippingPriceInfoClass
|
void |
setDefaultTaxPriceInfoClass(java.lang.Class pDefaultTaxPriceInfoClass)
Sets property defaultTaxPriceInfoClass
|
void |
setGiftlistManager(GiftlistManager pGiftlistManager)
Sets the giftlistManager
|
void |
setHandlingTypeClassMap(java.util.Properties pProp)
sets a java.util.Properties object to contain the type to classname map for HandlingInstructions.
|
void |
setInventoryManager(InventoryManager pInventoryManager)
Sets the InventoryManager
|
void |
setItemDescriptorToBeanNameMap(java.util.Properties pItemToBeanMap)
Set the map that maps item descriptor names to the corresponding bean
implementation classes.
|
void |
setOrderFixedAmountAdjustmentType(java.lang.String pOrderFixedAmountAdjustmentType)
Sets the OrderFixedAmountAdjustmentType
|
void |
setOrderItemDescriptorName(java.lang.String pOrderItemDescriptorName)
Sets the OrderItemDescriptorName
|
void |
setOrderLookupService(atg.commerce.order.OrderLookupService pOrderLookupService)
The service that is actually used to find the desired orders
|
void |
setOrderRepository(Repository pOrderRepository)
Sets the orderRepository
|
void |
setOrderTypeClassMap(java.util.Properties pProp)
sets a java.util.Properties object to contain the type to classname map for Orders.
|
void |
setPaymentGroupBillingAddressClassNameMap(java.util.Properties pPaymentGroupBillingAddressClassNameMap)
Sets property paymentGroupBillingAddressClassNameMap
|
void |
setPaymentTypeClassMap(java.util.Properties pProp)
sets a java.util.Properties object to contain the type to classname map for PaymentGroups.
|
void |
setPipelineManager(PipelineManager pPipelineManager)
Sets the pipelineManager
|
void |
setProfileRepository(Repository pProfileRepository)
Sets the profileRepository
|
void |
setProfileTools(CommerceProfileTools pProfileTools)
Sets the profileTools
|
void |
setQuoteInfoItemDescriptorName(java.lang.String pQuoteInfoItemDescriptorName)
Sets the QuoteInfoItemDescriptorName
|
void |
setRelationshipTypeClassMap(java.util.Properties pProp)
sets a java.util.Properties object to contain the type to classname map for Relationships.
|
void |
setShippingGroupShippingAddressClassNameMap(java.util.Properties pShippingGroupShippingAddressClassNameMap)
Sets property shippingGroupShippingAddressClassNameMap
|
void |
setShippingTypeClassMap(java.util.Properties pProp)
sets a java.util.Properties object to contain the type to classname map for ShippingGroups.
|
void |
setTransactionManager(javax.transaction.TransactionManager pTransactionManager) |
addLogListener, createAdminServlet, 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 java.lang.String getOrderFixedAmountAdjustmentType()
public void setOrderFixedAmountAdjustmentType(java.lang.String pOrderFixedAmountAdjustmentType)
public void setOrderLookupService(atg.commerce.order.OrderLookupService pOrderLookupService)
pOrderLookupService
- the OrderLookupService component. Usually /atg/commerce/order/OrderLookupServicepublic atg.commerce.order.OrderLookupService getOrderLookupService()
public PipelineManager getPipelineManager()
public void setPipelineManager(PipelineManager pPipelineManager)
public GiftlistManager getGiftlistManager()
public void setGiftlistManager(GiftlistManager pGiftlistManager)
public InventoryManager getInventoryManager()
public void setInventoryManager(InventoryManager pInventoryManager)
public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)
public javax.transaction.TransactionManager getTransactionManager()
public CommerceProfileTools getProfileTools()
public void setProfileTools(CommerceProfileTools pProfileTools)
public CatalogTools getCatalogTools()
public void setCatalogTools(CatalogTools pCatalogTools)
public Repository getOrderRepository()
public void setOrderRepository(Repository pOrderRepository)
public Repository getProfileRepository()
public void setProfileRepository(Repository pProfileRepository)
public java.lang.String getOrderItemDescriptorName()
public void setOrderItemDescriptorName(java.lang.String pOrderItemDescriptorName)
public java.lang.String getQuoteInfoItemDescriptorName()
public void setQuoteInfoItemDescriptorName(java.lang.String pQuoteInfoItemDescriptorName)
public java.lang.String getDefaultProfileType()
public void setDefaultProfileType(java.lang.String pDefaultProfileType)
public java.lang.Class getDefaultOrderPriceInfoClass()
public void setDefaultOrderPriceInfoClass(java.lang.Class pDefaultOrderPriceInfoClass)
pDefaultOrderPriceInfoClass
- the value to set for property defaultOrderPriceInfoClasspublic java.lang.Class getDefaultItemPriceInfoClass()
public void setDefaultItemPriceInfoClass(java.lang.Class pDefaultItemPriceInfoClass)
pDefaultItemPriceInfoClass
- the value to set for property defaultItemPriceInfoClasspublic java.lang.Class getDefaultShippingPriceInfoClass()
public void setDefaultShippingPriceInfoClass(java.lang.Class pDefaultShippingPriceInfoClass)
pDefaultShippingPriceInfoClass
- the value to set for property defaultShippingPriceInfoClasspublic java.lang.Class getDefaultTaxPriceInfoClass()
public void setDefaultTaxPriceInfoClass(java.lang.Class pDefaultTaxPriceInfoClass)
pDefaultTaxPriceInfoClass
- the value to set for property defaultTaxPriceInfoClasspublic java.util.Properties getOrderTypeClassMap()
public void setOrderTypeClassMap(java.util.Properties pProp)
public java.util.Properties getCommerceItemTypeClassMap()
public void setCommerceItemTypeClassMap(java.util.Properties pProp)
public java.util.Properties getShippingTypeClassMap()
public void setShippingTypeClassMap(java.util.Properties pProp)
public java.util.Properties getPaymentTypeClassMap()
public void setPaymentTypeClassMap(java.util.Properties pProp)
public java.util.Properties getHandlingTypeClassMap()
public void setHandlingTypeClassMap(java.util.Properties pProp)
public java.util.Properties getCostCenterTypeClassMap()
public void setCostCenterTypeClassMap(java.util.Properties pProp)
public java.util.Properties getRelationshipTypeClassMap()
public void setRelationshipTypeClassMap(java.util.Properties pProp)
public java.util.Properties getBeanNameToItemDescriptorMap()
public void setBeanNameToItemDescriptorMap(java.util.Properties pBeanNameToItemDescriptorMap)
public java.util.Properties getItemDescriptorToBeanNameMap()
public void setItemDescriptorToBeanNameMap(java.util.Properties pItemToBeanMap)
beanNameToItemDescriptorMap
. This method is provided
for applications that must explicitly override the default reverse
mapping for some reason.public java.lang.String getMappedItemDescriptorName(java.lang.String pBeanName)
pBeanName
- the bean namepublic java.lang.String getMappedBeanName(java.lang.String pRepItemName)
pRepItemName
- the repository item namepublic java.lang.String getItemDescriptorForOrderType(java.lang.String pOrderType) throws CommerceException
orderTypeClassMap
, then returns the matching repository
item descriptor name from the beanNameToItemDescriptorMap
.pOrderType
- An order type key, e.g. "default" or "b2bOrder".CommerceException
public java.lang.String getItemDescriptorForCommerceItemType(java.lang.String pCommerceItemType) throws CommerceException
commerceItemTypeClassMap
, then returns the matching repository
item descriptor name from the beanNameToItemDescriptorMap
.pCommerceItemType
- A commerce item type key, e.g. "default" or "configurableCommerceItem".CommerceException
public java.lang.String getItemDescriptorForShippingType(java.lang.String pShippingType) throws CommerceException
shippingTypeClassMap
, then returns the matching repository
item descriptor name from the beanNameToItemDescriptorMap
.pShippingType
- A shipping group type key, e.g. "hardgoodShippingGroup".CommerceException
public java.lang.String getItemDescriptorForPaymentType(java.lang.String pPaymentType) throws CommerceException
paymentTypeClassMap
, then returns the matching repository
item descriptor name from the beanNameToItemDescriptorMap
.pPaymentType
- A shipping group type key, e.g. "creditCard" or "storeCredit".CommerceException
public java.lang.String getDefaultOrderType()
public void setDefaultOrderType(java.lang.String pDefaultOrderType)
public java.lang.String getDefaultCommerceItemType()
public void setDefaultCommerceItemType(java.lang.String pDefaultCommerceItemType)
public java.lang.String getDefaultShippingGroupType()
public void setDefaultShippingGroupType(java.lang.String pDefaultShippingGroupType)
public java.lang.String getDefaultPaymentGroupType()
public void setDefaultPaymentGroupType(java.lang.String pDefaultPaymentGroupType)
public java.lang.String getDefaultHandlingInstructionType()
public void setDefaultHandlingInstructionType(java.lang.String pDefaultHandlingInstructionType)
public java.lang.String getDefaultCostCenterType()
public void setDefaultCostCenterType(java.lang.String pDefaultCostCenterType)
public boolean getCreateDefaultShippingGroup()
public void setCreateDefaultShippingGroup(boolean pCreateDefaultShippingGroup)
pCreateDefaultShippingGroup
- the value to set for property createDefaultShippingGrouppublic boolean getCreateDefaultPaymentGroup()
public void setCreateDefaultPaymentGroup(boolean pCreateDefaultPaymentGroup)
pCreateDefaultPaymentGroup
- the value to set for property createDefaultPaymentGrouppublic boolean getCreateDefaultCostCenter()
public void setCreateDefaultCostCenter(boolean pCreateDefaultCostCenter)
pCreateDefaultCostCenter
- the value to set for property createDefaultCostCenterpublic java.util.Properties getPaymentGroupBillingAddressClassNameMap()
public void setPaymentGroupBillingAddressClassNameMap(java.util.Properties pPaymentGroupBillingAddressClassNameMap)
pPaymentGroupBillingAddressClassNameMap
- the value to set for property paymentGroupBillingAddressClassNameMappublic java.util.Properties getShippingGroupShippingAddressClassNameMap()
public void setShippingGroupShippingAddressClassNameMap(java.util.Properties pShippingGroupShippingAddressClassNameMap)
pShippingGroupShippingAddressClassNameMap
- the value to set for property shippingGroupShippingAddressClassNameMappublic java.lang.String getDefaultPaymentGroupAddressType()
public void setDefaultPaymentGroupAddressType(java.lang.String pDefaultPaymentGroupAddressType)
pDefaultPaymentGroupAddressType
- the value to set for property defaultPaymentGroupAddressTypepublic java.lang.String getDefaultShippingGroupAddressType()
public void setDefaultShippingGroupAddressType(java.lang.String pDefaultShippingGroupAddressType)
pDefaultShippingGroupAddressType
- the value to set for property defaultShippingGroupAddressTypepublic void setAssignCatalogInCommerceItem(boolean pAssignCatalogInCommerceItem)
public boolean isAssignCatalogInCommerceItem()
public void doStartService()
itemDescriptorToBeanNameMap
was set explicitly in the
component's configuration file. If it was not, the map contents are
computed at startup by inverting the key/value pairs in
beanNameToItemDescriptorMap
.doStartService
in class GenericService
protected java.util.Properties invertBeanToItemMap(java.util.Properties pBeanToItemMap)
pBeanToItemMap
and return
a new Properties object containing the inverted map.public Order createOrder(java.lang.String pType) throws CommerceException
pType
- the type which is mapped to the class to useObjectCreationException
- if the instantiation of an object failsInvalidTypeException
- if the supplied type is not mapped to any classCommerceException
public Order createOrder(java.lang.String pType, java.lang.String pOrderId) throws CommerceException
pType
- the type which is mapped to the class to useObjectCreationException
- if the instantiation of an object failsInvalidTypeException
- if the supplied type is not mapped to any classCommerceException
public Order createOrder(java.lang.String pType, ShippingPriceInfo pShippingPriceInfo) throws CommerceException
pType
- the type which is mapped to the class to usepShippingPriceInfo
- the priceInfo to set into the ShippingGroupObjectCreationException
- if the instantiation of an object failsInvalidTypeException
- if the supplied type is not mapped to any classCommerceException
public Order createOrder(java.lang.String pType, java.lang.String pOrderId, ShippingPriceInfo pShippingPriceInfo) throws CommerceException
pType
- the type which is mapped to the class to usepOrderId
- the order id to assign to this new OrderpShippingPriceInfo
- the priceInfo to set into the ShippingGroupObjectCreationException
- if the instantiation of an object failsInvalidTypeException
- if the supplied type is not mapped to any classCommerceException
public CommerceItem createCommerceItem(java.lang.String pType) throws CommerceException
pType
- the type which is mapped to the class to useObjectCreationException
- if the instantiation of an object failsInvalidTypeException
- if the supplied type is not mapped to any classCommerceException
public ShippingGroup createShippingGroup(java.lang.String pType) throws CommerceException
pType
- the type which is mapped to the class to useObjectCreationException
- if the instantiation of an object failsInvalidTypeException
- if the supplied type is not mapped to any classCommerceException
public ShippingGroup createShippingGroup(java.lang.String pType, ShippingPriceInfo pShippingPriceInfo) throws CommerceException
pType
- the type which is mapped to the class to usepShippingPriceInfo
- the price info to set into the ShippingGroupObjectCreationException
- if the instantiation of an object failsInvalidTypeException
- if the supplied type is not mapped to any classCommerceException
public PaymentGroup createPaymentGroup(java.lang.String pType) throws CommerceException
pType
- the type which is mapped to the class to useObjectCreationException
- if the instantiation of an object failsInvalidTypeException
- if the supplied type is not mapped to any classCommerceException
public HandlingInstruction createHandlingInstruction(java.lang.String pType) throws CommerceException
pType
- the type which is mapped to the class to useObjectCreationException
- if the instantiation of an object failsInvalidTypeException
- if the supplied type is not mapped to any classCommerceException
public CostCenter createCostCenter(java.lang.String pType) throws CommerceException
pType
- the type which is mapped to the class to useObjectCreationException
- if the instantiation of an object failsInvalidTypeException
- if the supplied type is not mapped to any classCommerceException
public Relationship createRelationship(java.lang.String pType) throws CommerceException
pType
- the type which is mapped to the class to useObjectCreationException
- if the instantiation of an object failsInvalidTypeException
- if the supplied type is not mapped to any classCommerceException
public void initializeRelationship(Order pOrder, ShippingGroupCommerceItemRelationship pRelationship, java.lang.String pShippingGroupId, java.lang.String pCommerceItemId) throws CommerceException
pOrder
- the Order object which contains the CommerceItem and ShippingGroup to add the Relationship topRelationship
- the relationship object to add to the Order.pShippingGroupId
- the id of the ShippingGroup object which makes up a half of the relationshippCommerceItemId
- the id of the CommerceItem object which makes up a half of the relationshipInvalidParameterException
- if any of the given method parameters are invalidInvalidTypeException
- if there is more than one SHIPPINGQUANTITYREMAINING relationship type
in the CommerceItemCommerceException
public void initializeRelationship(Order pOrder, PaymentGroupCommerceItemRelationship pRelationship, java.lang.String pPaymentGroupId, java.lang.String pCommerceItemId) throws CommerceException
pOrder
- the Order object which contains the CommerceItem and PaymentGroup to add the Relationship topRelationship
- the relationship object to add to the Order.pPaymentGroupId
- the id of the PaymentGroup object which makes up a half of the relationshippCommerceItemId
- the id of the CommerceItem object which makes up a half of the relationshipInvalidParameterException
- if any of the given method parameters are invalidInvalidTypeException
- if there is more than one PAYMENTAMOUNTREMAINING
relationship type in the CommerceItemCommerceException
public void initializeRelationship(Order pOrder, PaymentGroupShippingGroupRelationship pRelationship, java.lang.String pPaymentGroupId, java.lang.String pShippingGroupId) throws CommerceException
pOrder
- the Order object which contains the ShippingGroup and PaymentGroup to add the Relationship topRelationship
- the relationship object to add to the Order.pPaymentGroupId
- the id of the PaymentGroup object which makes up a half of the relationshippShippingGroupId
- the id of the ShippingGroup object which makes up a half of the relationshipInvalidParameterException
- if any of the given method parameters are invalidInvalidTypeException
- if there is more than one SHIPPINGPRICEREMAINING relationship type
in the ShippingGroupCommerceException
public void initializeRelationship(Order pOrder, PaymentGroupOrderRelationship pRelationship, java.lang.String pPaymentGroupId) throws CommerceException
pOrder
- the Order object which contains the PaymentGroup to add the Relationship topRelationship
- the relationship object to add to the Order.pPaymentGroupId
- the id of the PaymentGroup object which makes up a half of the relationshipInvalidParameterException
- if any of the given method parameters are invalidInvalidTypeException
- if there is more than one TAXAMOUNTREMAINING relationship type in
the OrderCommerceException
public void initializeRelationship(Order pOrder, CostCenterCommerceItemRelationship pRelationship, java.lang.String pCostCenterId, java.lang.String pCommerceItemId) throws CommerceException
pOrder
- the Order object which contains the CommerceItem and CostCenter to add the Relationship topRelationship
- the relationship object to add to the Order.pCostCenterId
- the id of the CostCenter object which makes up a half of the relationshippCommerceItemId
- the id of the CommerceItem object which makes up a half of the relationshipInvalidParameterException
- if any of the given method parameters are invalidInvalidTypeException
- if there is more than one QUANTITYREMAINING relationship type
in the CommerceItemCommerceException
public void initializeRelationship(Order pOrder, CostCenterShippingGroupRelationship pRelationship, java.lang.String pCostCenterId, java.lang.String pShippingGroupId) throws CommerceException
pOrder
- the Order object which contains the ShippingGroup and CostCenter to add the Relationship topRelationship
- the relationship object to add to the Order.pCostCenterId
- the id of the CostCenter object which makes up a half of the relationshippShippingGroupId
- the id of the ShippingGroup object which makes up a half of the relationshipInvalidParameterException
- if any of the given method parameters are invalidInvalidTypeException
- if there is more than one CCSHIPPINGAMOUNTREMAINING relationship type
in the ShippingGroupCommerceException
public void initializeRelationship(Order pOrder, CostCenterOrderRelationship pRelationship, java.lang.String pCostCenterId) throws CommerceException
pOrder
- the Order object which contains the CostCenter to add the Relationship topRelationship
- the relationship object to add to the Order.pCostCenterId
- the id of the CostCenter object which makes up a half of the relationshipInvalidParameterException
- if any of the given method parameters are invalidInvalidTypeException
- if there is more than one CCTAXAMOUNTREMAINING relationship type in
the OrderCommerceException
public static void copyAddress(RepositoryItem pProfileAddress, Address pAddress) throws CommerceException
pProfileAddress
- a non-null profile address that contains user informationpAddress
- a non-null address or ContactInfo to copy the user data intoCommerceException
- if an error occurs while copyingpublic static void copyAddress(Address pAddress, RepositoryItem pProfileAddress) throws CommerceException
pAddress
- a non-null address or ContactInfo to copy the user data frompProfileAddress
- a non-null profile address that contains user information to copy intoCommerceException
- if an error occurs while copyingpublic static void copyAddress(Address pSrcAddress, Address pDestAddress) throws CommerceException
pSrcAddress
- the non-null object that the data will be copied frompDestAddress
- the non-null object that the data will be copied intoCommerceException
- if an error occurs while copyingprotected boolean isNullAddress(Address pAddress)
protected boolean isNullCreditCard(CreditCard pCreditCard)
public boolean isOrderState(Order pOrder, java.lang.String[] pStates)
pOrder
- pStates
- array of states.public RepositoryItem createOrderFixedAmountAdjustment(Order pOrder, double pAmount, java.lang.String pAdjustmentType, java.lang.String pNotes, java.lang.String pReasonCode) throws RepositoryException
Note that transaction boundaries are not demarcated and updateOrder is not called by this method. Both are expected to be handled by the caller.
Creates an item based on the type defined by the property orderFixedAmountAdjustmentType
pOrder
- pAmount
- pAdjustmentType
- pNotes
- pReasonCode
- RepositoryException
protected void addManualAdjustment(Order pOrder, RepositoryItem pAdjustment)
pOrder
- pAdjustment
- public void addManualAdjustment(Order pOrder, RepositoryItem pAdjustment, int pIndex)
pOrder
- pAdjustment
- pIndex
- protected MutableRepositoryItem createManualAdjustmentItem(java.lang.String pItemType, double pAmount, java.lang.String pAdjustmentType, java.lang.String pNotes, java.lang.String pReasonCode) throws RepositoryException
pItemType
- pAmount
- pAdjustmentType
- pNotes
- pReasonCode
- RepositoryException
public boolean deleteManualAdjustment(Order pOrder, java.lang.String pAdjustmentItemId) throws RepositoryException
Note that transaction boundaries are not demarcated and updateOrder is not called by this method. Both are expected to be handled by the caller.
pOrder
- pAdjustmentItemId
- RepositoryException
public MutableRepositoryItem createQuoteInfoItem(java.lang.String pItemType) throws RepositoryException
pItemType
- - the type of the repository item to create, which
must either a quote info type/subtype or support the same properties
as a quote info item.RepositoryException
public void addQuoteInfo(Order pOrder, RepositoryItem pQuoteInfo)
pOrder
- - the order to add a quote info item topQuoteInfo
- - the quote info item to addpublic void registerSynchronization(Order pOrder)
pOrder
- the order which is used for synchronizationpublic java.util.Collection findShippingGroupsWithAddress(Order pOrder, Address pAddress, java.lang.String[] pPropertyNamesToCompare)
pOrder
- the order containing the shipping groupspAddress
- the address to compare to shipping group addressespPropertyNamesToCompare
- the properties of the address that are used to determine equalitypublic int[] convertStateStringsToInts(java.lang.String[] pStateStrings)
pStateStrings
- An array of state strings (ie "submitted")public java.util.Map addBypassPaymentGroupAuthorizationParameter(java.util.Map pExtraParameters)
pExtraParameters
- PipelineConstants.BYPASSPAYMENTAUTHORIZATIONS
public java.util.Map addBypassExpiredPromotionsCheckParameter(java.util.Map pExtraParameters)
pExtraParameters
- PipelineConstants.BYPASSEXPIREDPROMOTIONSCHECK
public java.util.Map addAllowPartialInStorePayment(java.util.Map pExtraParameters)
pExtraParameters
- PipelineConstants.ALLOWPARTIALINSTOREPAYMENT