public class CSRConfigurator
extends atg.nucleus.GenericService
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
protected java.lang.String |
mCartShareableTypeId |
protected java.lang.String |
mCommerceSiteType |
protected java.lang.String |
mDefaultSiteIconURL
The default site icon image URL that is used when the selected site does not
have an associated site icon defined in the repository
|
protected java.lang.String |
mDefaultSiteId |
protected CommerceTypeConfiguration[] |
mPaymentGroupTypeConfigurations |
protected java.util.Map |
mPaymentGroupTypeConfigurationsAsMap |
protected java.lang.String |
mPaymentGroupTypesToBeInitialized |
protected atg.commerce.pricing.PricingTools |
mPricingTools |
protected CommerceTypeConfiguration[] |
mShippingGroupTypeConfigurations |
protected java.util.Map |
mShippingGroupTypeConfigurationsAsMap |
protected java.lang.String |
mShippingGroupTypesToBeInitialized |
protected java.lang.String[] |
mSupportedPaymentGroupTypes |
protected CommerceTypeConfiguration |
mUnknownPaymentGroupType |
protected boolean |
mUseProductId
This flag determines if Product Id field is used
on Add Products by Id page, Product Catalog Search and so on
|
protected boolean |
mUseSKUId
This flag determines if SKU Id field is used
on Add Products by Id page, Product Catalog Search and so on
|
protected boolean |
mUsingEndecaCatalogSearch |
protected boolean |
mUsingGiftlists |
protected boolean |
mUsingInStorePickup |
protected boolean |
mUsingOrderApprovals |
protected boolean |
mUsingScheduledOrders |
Constructor and Description |
---|
CSRConfigurator() |
Modifier and Type | Method and Description |
---|---|
protected java.util.Map |
convertArraysToMapByType(CommerceTypeConfiguration[] pTypeConfigurations)
This method converts an array into Map.
|
java.lang.String |
getCartShareableTypeId()
Returns the cartShareableTypeId
|
atg.commerce.catalog.CatalogTools |
getCatalogTools()
Returns The catalog tools
|
java.lang.String |
getCommerceSiteType()
Returns the commerceSiteType
|
java.lang.String |
getContextRoot()
Returns the contextRoot
|
java.lang.String |
getDefaultAppeasementLimit(java.lang.String pCurrencyCode) |
java.util.Properties |
getDefaultAppeasementLimits() |
java.lang.String |
getDefaultCatalogId()
Returns the catalog that's assigned whenever a new anonymous user profile is created
and custom catalog is enabled in the CSRConfigurator
|
java.lang.String |
getDefaultSiteIconURL() |
java.lang.String |
getDefaultSiteId()
Returns the defaultSiteId
|
int |
getMaximumAlmostQualifiedForPromotionsInShortList() |
java.lang.String[] |
getPaymentGroupConfigurationTypes()
Returns the payment group types that have a
CommerceTypeConfiguration
configured. |
CommerceTypeConfiguration[] |
getPaymentGroupTypeConfigurations()
Returns the paymentGroupTypeConfigurations
This property is used to configure all payment group type configurations.
|
java.util.Map |
getPaymentGroupTypeConfigurationsAsMap()
Returns the paymentGroupTypeConfigurationsAsMap
This method converts
getPaymentGroupTypeConfigurations() into a map. |
java.lang.String |
getPaymentGroupTypesToBeInitialized()
Returns the paymentGroupTypesToBeInitialized
This property is used to provide list of payment group types to be initialized
by the
PaymentGroupDroplet . |
atg.commerce.pricing.PricingTools |
getPricingTools()
Returns the pricingTools
|
int |
getQuantityInputTagMaxlength()
Item quantity input tag's 'maxlength' attribute
|
int |
getQuantityInputTagSize()
Item quantity input tag's 'size' attribute
|
CommerceTypeConfiguration[] |
getShippingGroupTypeConfigurations()
Returns the shippingGroupTypeConfigurations
This property is used to configure all shipping group type configurations.
|
java.util.Map |
getShippingGroupTypeConfigurationsAsMap()
Returns the shippingGroupTypeConfigurationsAsMap
This method converts
getShippingGroupTypeConfigurations() into a map. |
java.lang.String |
getShippingGroupTypesToBeInitialized()
Returns the shippingGroupTypesToBeInitialized
This property is used to provide list of shipping group types to be initialized
by the
ShippingGroupDroplet . |
java.lang.String[] |
getSupportedPaymentGroupTypes()
Defines the payment group types that are supported for
modifying orders in CSC.
|
CommerceTypeConfiguration |
getUnknownPaymentGroupType()
Returns the payment group type configuration for unknown types
|
boolean |
isCustomCatalogs()
Returns boolean indicating if custom catalogs are in use
|
boolean |
isProcessReturnRequestImmediately()
The default value is false.
|
boolean |
isUseProductId()
Returns boolean indicating if Product Id field is in use
|
boolean |
isUseSKUId()
Returns boolean indicating if SKU Id field is in use
|
boolean |
isUsingEndecaCatalogSearch()
Returns true if endeca catalog search is being used.
|
boolean |
isUsingGiftlists()
This flag determines if Gift Registry features show up in
the UI.
|
boolean |
isUsingInStorePickup()
This flag determines if In StorePickup features show up in
the UI.
|
boolean |
isUsingOrderApprovals()
This flag determines if the Order Approvals features is enabled
|
boolean |
isUsingPriceLists()
Returns boolean indicating whether price lists are being used
|
boolean |
isUsingSalePriceLists()
Returns boolean indicating whether a sale price list is being used
|
boolean |
isUsingScheduledOrders()
This flag determines if scheduled order features show up in
the UI.
|
void |
setCartShareableTypeId(java.lang.String pCartShareableTypeId)
Sets the cartShareableTypeId
|
void |
setCatalogTools(atg.commerce.catalog.CatalogTools pCatalogTools)
Sets catalogTools
|
void |
setCommerceSiteType(java.lang.String pCommerceSiteType)
Sets the commerceSiteType
|
void |
setContextRoot(java.lang.String pContextRoot)
Sets the contextRoot
|
void |
setCustomCatalogs(boolean pCustomCatalogs)
boolean indicating if custom catalogs are in use
|
void |
setDefaultAppeasementLimits(java.util.Properties pDefaultAppeasementLimits)
Sets a map of appeasement limit defaults keyed by currency code.
|
void |
setDefaultCatalogId(java.lang.String pDefaultCatalogId)
This catalog is assigned whenever a new anonymous user profile is created
and custom catalog is enabled in the CSRConfigurator.
|
void |
setDefaultSiteIconURL(java.lang.String pDefaultSiteIconURL) |
void |
setDefaultSiteId(java.lang.String pDefaultSiteId)
Sets the defaultSiteId
|
void |
setMaximumAlmostQualifiedForPromotionsInShortList(int pMax) |
void |
setPaymentGroupTypeConfigurations(CommerceTypeConfiguration[] pPaymentGroupTypeConfigurations)
Sets the paymentGroupTypeConfigurations
This property is used to configure all payment group type configurations.
|
void |
setPaymentGroupTypesToBeInitialized(java.lang.String pPaymentGroupTypesToBeInitialized)
Sets the paymentGroupTypesToBeInitialized
This property is used to provide list of payment group types to be initialized
by the
PaymentGroupDroplet . |
void |
setPricingTools(atg.commerce.pricing.PricingTools pPricingTools)
Sets the pricingTools
|
void |
setProcessReturnRequestImmediately(boolean pProcessReturnRequestImmediately)
The default value is false.
|
void |
setQuantityInputTagMaxlength(int pMax)
Item quantity input tag's 'maxlength' attribute
|
void |
setQuantityInputTagSize(int pSize)
Item quantity input tag's 'size' attribute
|
void |
setShippingGroupTypeConfigurations(CommerceTypeConfiguration[] pShippingGroupTypeConfigurations)
Sets the shippingGroupTypeConfigurations
This property is used to configure all shipping group type configurations.
|
void |
setShippingGroupTypesToBeInitialized(java.lang.String pShippingGroupTypesToBeInitialized)
Sets the shippingGroupTypesToBeInitialized
This property is used to provide list of shipping group types to be initialized
by the
ShippingGroupDroplet . |
void |
setSupportedPaymentGroupTypes(java.lang.String[] pSupportedPaymentGroupTypes) |
void |
setUnknownPaymentGroupType(CommerceTypeConfiguration pUnknownPaymentGroupType)
Sets the payment group type configuration for unknown types
|
void |
setUseProductId(boolean pUseProductId) |
void |
setUseSKUId(boolean pUseSKUId) |
void |
setUsingEndecaCatalogSearch(boolean pUsingEndecaCatalogSearch) |
void |
setUsingGiftlists(boolean pUsingGiftlists) |
void |
setUsingInStorePickup(boolean pUsingInStorePickup) |
void |
setUsingOrderApprovals(boolean pUsingOrderApprovals) |
void |
setUsingPriceLists(boolean pUsingPriceLists)
Sets boolean indicating whether price lists are being used
|
void |
setUsingSalePriceLists(boolean pUsingSalePriceLists)
Sets boolean indicating whether a sale price list is being used
|
void |
setUsingScheduledOrders(boolean pUsingScheduledOrders) |
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
protected boolean mUsingEndecaCatalogSearch
protected boolean mUsingScheduledOrders
protected boolean mUsingGiftlists
protected boolean mUsingInStorePickup
protected java.lang.String mShippingGroupTypesToBeInitialized
protected CommerceTypeConfiguration[] mShippingGroupTypeConfigurations
protected java.util.Map mShippingGroupTypeConfigurationsAsMap
protected java.lang.String mPaymentGroupTypesToBeInitialized
protected CommerceTypeConfiguration[] mPaymentGroupTypeConfigurations
protected java.util.Map mPaymentGroupTypeConfigurationsAsMap
protected CommerceTypeConfiguration mUnknownPaymentGroupType
protected java.lang.String[] mSupportedPaymentGroupTypes
protected java.lang.String mDefaultSiteId
protected java.lang.String mCartShareableTypeId
protected boolean mUsingOrderApprovals
protected java.lang.String mCommerceSiteType
protected java.lang.String mDefaultSiteIconURL
protected boolean mUseSKUId
protected boolean mUseProductId
protected atg.commerce.pricing.PricingTools mPricingTools
public boolean isUsingEndecaCatalogSearch()
public void setUsingEndecaCatalogSearch(boolean pUsingEndecaCatalogSearch)
public boolean isUsingScheduledOrders()
public void setUsingScheduledOrders(boolean pUsingScheduledOrders)
public boolean isUsingGiftlists()
public void setUsingGiftlists(boolean pUsingGiftlists)
public boolean isUsingInStorePickup()
public void setUsingInStorePickup(boolean pUsingInStorePickup)
public boolean isProcessReturnRequestImmediately()
public void setProcessReturnRequestImmediately(boolean pProcessReturnRequestImmediately)
pProcessReturnRequestImmediately
- public void setCatalogTools(atg.commerce.catalog.CatalogTools pCatalogTools)
pCatalogTools
- the catalog toolspublic atg.commerce.catalog.CatalogTools getCatalogTools()
public void setCustomCatalogs(boolean pCustomCatalogs)
pCustomCatalogs
- boolean indicating if custom catalogs are in usepublic boolean isCustomCatalogs()
public void setUsingPriceLists(boolean pUsingPriceLists)
pUsingPriceLists
- boolean indicating whether price lists are being usedpublic boolean isUsingPriceLists()
public void setUsingSalePriceLists(boolean pUsingSalePriceLists)
pUsingSalePriceLists
- boolean indicating whether a sale price list is being usedpublic boolean isUsingSalePriceLists()
public void setContextRoot(java.lang.String pContextRoot)
pContextRoot
- the context rootpublic java.lang.String getContextRoot()
public void setDefaultCatalogId(java.lang.String pDefaultCatalogId)
pDefaultCatalogId
- the custom catalog idpublic java.lang.String getDefaultCatalogId()
public int getMaximumAlmostQualifiedForPromotionsInShortList()
public void setMaximumAlmostQualifiedForPromotionsInShortList(int pMax)
pMax
- The maximum number of nearly qualified for promotions
to display in a short listpublic int getQuantityInputTagSize()
public void setQuantityInputTagSize(int pSize)
public int getQuantityInputTagMaxlength()
public void setQuantityInputTagMaxlength(int pMax)
public java.lang.String getShippingGroupTypesToBeInitialized()
ShippingGroupDroplet
. Out of box the HardgoodShippingGroup
and ElectroniShippingGroup
are initialized. If you want to include or exclude any shipping
groups, you need to modify this property. This property is only used with ShippingGroupDroplet
ShippingGroupDroplet.getShippingGroupTypes()
public void setShippingGroupTypesToBeInitialized(java.lang.String pShippingGroupTypesToBeInitialized)
ShippingGroupDroplet
. Out of box the HardgoodShippingGroup
and ElectroniShippingGroup
are initialized. If you want to include or exclude any shipping
groups, you need to modify this property. This property is only used with ShippingGroupDroplet
pShippingGroupTypesToBeInitialized
- the shippingGroupTypesToBeInitialized to setShippingGroupDroplet.getShippingGroupTypes()
public java.lang.String getPaymentGroupTypesToBeInitialized()
PaymentGroupDroplet
. Out of box the CreditCard
and StoreCredit
are initialized. If you want to include or exclude any payment
groups, you need to modify this property. This property is only used with PaymentGroupDroplet
PaymentGroupDroplet.getPaymentGroupTypes()
public void setPaymentGroupTypesToBeInitialized(java.lang.String pPaymentGroupTypesToBeInitialized)
PaymentGroupDroplet
. Out of box the CreditCard
and StoreCredit
are initialized. If you want to include or exclude any payment
groups, you need to modify this property. This property is only used with PaymentGroupDroplet
pPaymentGroupTypesToBeInitialized
- the paymentGroupTypesToBeInitialized to setPaymentGroupDroplet.getPaymentGroupTypes()
public CommerceTypeConfiguration[] getShippingGroupTypeConfigurations()
public void setShippingGroupTypeConfigurations(CommerceTypeConfiguration[] pShippingGroupTypeConfigurations)
pShippingGroupTypeConfigurations
- the shippingGroupTypeConfigurations to setpublic java.util.Map getShippingGroupTypeConfigurationsAsMap()
getShippingGroupTypeConfigurations()
into a map.convertArraysToMapByType(CommerceTypeConfiguration[])
public CommerceTypeConfiguration[] getPaymentGroupTypeConfigurations()
public void setPaymentGroupTypeConfigurations(CommerceTypeConfiguration[] pPaymentGroupTypeConfigurations)
pPaymentGroupTypeConfigurations
- the paymentGroupByTypeConfigurations to setpublic CommerceTypeConfiguration getUnknownPaymentGroupType()
public void setUnknownPaymentGroupType(CommerceTypeConfiguration pUnknownPaymentGroupType)
pUnknownPaymentGroupType
- the mUnknownPaymentGroupType to setpublic java.util.Map getPaymentGroupTypeConfigurationsAsMap()
getPaymentGroupTypeConfigurations()
into a map.convertArraysToMapByType(CommerceTypeConfiguration[])
public java.lang.String[] getPaymentGroupConfigurationTypes()
CommerceTypeConfiguration
configured.public java.lang.String[] getSupportedPaymentGroupTypes()
public void setSupportedPaymentGroupTypes(java.lang.String[] pSupportedPaymentGroupTypes)
protected java.util.Map convertArraysToMapByType(CommerceTypeConfiguration[] pTypeConfigurations)
pTypeConfigurations
array and uses the
CommerceTypeConfiguration.getType()
as the key and the TypeConfiguration
as value and generates a map.pTypeConfigurations
- The array that needs to be converted to a mapCommerceTypeConfiguration.getType()
as the key and
TypeConfiguration
as the value.public java.lang.String getDefaultSiteId()
public void setDefaultSiteId(java.lang.String pDefaultSiteId)
pDefaultSiteId
- the defaultSiteId to setpublic java.lang.String getCartShareableTypeId()
public void setCartShareableTypeId(java.lang.String pCartShareableTypeId)
pCartShareableTypeId
- the cartShareableTypeId to setpublic boolean isUsingOrderApprovals()
public void setUsingOrderApprovals(boolean pUsingOrderApprovals)
public java.lang.String getCommerceSiteType()
public void setCommerceSiteType(java.lang.String pCommerceSiteType)
pCommerceSiteType
- the commerceSiteType to setpublic void setDefaultAppeasementLimits(java.util.Properties pDefaultAppeasementLimits)
DefaultAppeasementLimits
- the pDefaultAppeasementLimits to setpublic java.util.Properties getDefaultAppeasementLimits()
public java.lang.String getDefaultAppeasementLimit(java.lang.String pCurrencyCode)
public java.lang.String getDefaultSiteIconURL()
public void setDefaultSiteIconURL(java.lang.String pDefaultSiteIconURL)
mDefaultSiteIconURL
- the mDefaultSiteIconURL to setpublic boolean isUseSKUId()
public void setUseSKUId(boolean pUseSKUId)
mUseSKUId
- the mUseSKUId to setpublic boolean isUseProductId()
public void setUseProductId(boolean pUseProductId)
mUseProductId
- the mUseProductId to setpublic atg.commerce.pricing.PricingTools getPricingTools()
public void setPricingTools(atg.commerce.pricing.PricingTools pPricingTools)
pPricingTools
- the pricingTools to set