atg.projects.store
Class StoreConfiguration

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.projects.store.StoreConfiguration

All Implemented Interfaces:

atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, java.util.EventListener

public class StoreConfiguration
extends atg.nucleus.GenericService

This class is used for store wide configurations.

Field Summary

static java.lang.String	CLASS_VERSION Class version string.
protected boolean	mAtgSearchInstalled Is ATG search installed.
protected java.lang.String	mBackInStockFromAddress Back in stock sender address.
protected java.lang.String	mCustomerServiceEmailAddress Customer service e-mail address.
protected java.lang.Integer	mDefaultPageSize Products per page
protected boolean	mDojoDebug Is Dojo debug turned on.
protected java.lang.String	mDojoUrl Dojo URL.
protected boolean	mEmailAFriendEnabled Should e-mail a friend.
protected java.util.Map	mFavoriteProductFeatures Favourite product features.
protected java.lang.String	mGiftCertificateFromAddress Gift certificate sender address.
protected java.util.List	mMandatoryStateCountryList Mandatory state country list.
protected java.lang.String	mNewPasswordFromAddress New password sender address.
protected long	mNewProductThresholdDays The newProductThresholdDays defines the number of days for which a Product is considered new.
protected java.lang.String	mOrderConfirmationFromAddress Order confirmation sender address.
protected java.lang.String	mOrderShippedFromAddress Order shipped sender address.
protected java.lang.String	mPromotionEmailAddress Promotion e-mail address.
protected boolean	mRequireCreditCardVerification Is credit card verification required.
protected boolean	mUseSearchForSubcategoryProductList Should use search for subcategory product list.

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

StoreConfiguration()

Method Summary

boolean	getAtgSearchInstalled()
java.lang.String	getBackInStockFromAddress()
java.lang.String	getCustomerServiceEmailAddress()
java.lang.String	getDefaultCountry()
java.lang.Integer	getDefaultPageSize() Gets products per page
java.lang.String	getDojoUrl()
java.util.Map	getFavoriteProductFeatures()
java.lang.String	getGiftCertificateFromAddress()
java.util.List	getMandatoryStateCountryList()
java.lang.String	getNewPasswordFromAddress()
long	getNewProductThresholdDays()
java.lang.String	getOrderConfirmationFromAddress()
java.lang.String	getOrderShippedFromAddress()
java.lang.String	getPromotionEmailAddress()
java.lang.String	getResourceBundle()
boolean	getUseSearchForSubcategoryProductList()
boolean	isDojoDebug() Enable dojo debugging?
boolean	isEmailAFriendEnabled()
boolean	isRequireCreditCardVerification() This property determines if credit card verification numbers are required by the application.
void	setAtgSearchInstalled(boolean pAtgSearchInstalled)
void	setBackInStockFromAddress(java.lang.String pBackInStockFromAddress)
void	setCustomerServiceEmailAddress(java.lang.String pCustomerServiceEmailAddress)
void	setDefaultCountry(java.lang.String pDefaultCountry)
void	setDefaultPageSize(java.lang.Integer pDefaultPageSize) Sets products per page
void	setDojoDebug(boolean pDojoDebug) Enables Dojo debug.
void	setDojoUrl(java.lang.String pDojoUrl) Sets the DojoUrl - this is the full url that will be used as the src= attribute to include all dojo Javascript within the app.
void	setEmailAFriendEnabled(boolean pEmailAFriendEnabled)
void	setFavoriteProductFeatures(java.util.Map pFavoriteProductFeatures)
void	setGiftCertificateFromAddress(java.lang.String pGiftCertificateFromAddress)
void	setMandatoryStateCountryList(java.util.List pMandatoryStateCountryList)
void	setNewPasswordFromAddress(java.lang.String pNewPasswordFromAddress)
void	setNewProductThresholdDays(long pNewProductThresholdDays)
void	setOrderConfirmationFromAddress(java.lang.String pOrderConfirmationFromAddress)
void	setOrderShippedFromAddress(java.lang.String pOrderShippedFromAddress)
void	setPromotionEmailAddress(java.lang.String pPromotionEmailAddress)
void	setRequireCreditCardVerification(boolean pRequireCreditCardVerification)
void	setResourceBundle(java.lang.String pResourceBundle)
void	setUseSearchForSubcategoryProductList(boolean pUseSearchForSubcategoryProductList)

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string.

See Also:

Constant Field Values

mEmailAFriendEnabled

protected boolean mEmailAFriendEnabled

Should e-mail a friend.

mAtgSearchInstalled

protected boolean mAtgSearchInstalled

Is ATG search installed.

mUseSearchForSubcategoryProductList

protected boolean mUseSearchForSubcategoryProductList

Should use search for subcategory product list.

mFavoriteProductFeatures

protected java.util.Map mFavoriteProductFeatures

Favourite product features.

mBackInStockFromAddress

protected java.lang.String mBackInStockFromAddress

Back in stock sender address.

mCustomerServiceEmailAddress

protected java.lang.String mCustomerServiceEmailAddress

Customer service e-mail address.

mGiftCertificateFromAddress

protected java.lang.String mGiftCertificateFromAddress

Gift certificate sender address.

mNewPasswordFromAddress

protected java.lang.String mNewPasswordFromAddress

New password sender address.

mOrderConfirmationFromAddress

protected java.lang.String mOrderConfirmationFromAddress

Order confirmation sender address.

mOrderShippedFromAddress

protected java.lang.String mOrderShippedFromAddress

Order shipped sender address.

mPromotionEmailAddress

protected java.lang.String mPromotionEmailAddress

Promotion e-mail address.

mRequireCreditCardVerification

protected boolean mRequireCreditCardVerification

Is credit card verification required.

mDojoUrl

protected java.lang.String mDojoUrl

Dojo URL.

mDojoDebug

protected boolean mDojoDebug

Is Dojo debug turned on.

mMandatoryStateCountryList

protected java.util.List mMandatoryStateCountryList

Mandatory state country list.

mNewProductThresholdDays

protected long mNewProductThresholdDays

The newProductThresholdDays defines the number of days for which a Product is considered new.

mDefaultPageSize

protected java.lang.Integer mDefaultPageSize

Products per page

Constructor Detail

StoreConfiguration

public StoreConfiguration()

Method Detail

getResourceBundle

public java.lang.String getResourceBundle()

Returns:

resource bundle path.

setResourceBundle

public void setResourceBundle(java.lang.String pResourceBundle)

Parameters:

pResourceBundle - - resource bundle path.

isEmailAFriendEnabled

public boolean isEmailAFriendEnabled()

Returns:

true if email a friend flag is enabled, false - otherwise.

setEmailAFriendEnabled

public void setEmailAFriendEnabled(boolean pEmailAFriendEnabled)

Parameters:

pEmailAFriendEnabled - - true to enable e-mail a friend flag, false - otherwise.

getAtgSearchInstalled

public boolean getAtgSearchInstalled()

Returns:

true if ATG search is installed, false - otherwise.

setAtgSearchInstalled

public void setAtgSearchInstalled(boolean pAtgSearchInstalled)

Parameters:

pAtgSearchInstalled - - true if ATG search is installed, false - otherwise.

getUseSearchForSubcategoryProductList

public boolean getUseSearchForSubcategoryProductList()

Returns:

true if search for subcategory product list should be used, false - otherwise.

setUseSearchForSubcategoryProductList

public void setUseSearchForSubcategoryProductList(boolean pUseSearchForSubcategoryProductList)

Parameters:

pUseSearchForSubcategoryProductList - - true if search for subcategory product list should be used.

getFavoriteProductFeatures

public java.util.Map getFavoriteProductFeatures()

Returns:

the favorite product features.

setFavoriteProductFeatures

public void setFavoriteProductFeatures(java.util.Map pFavoriteProductFeatures)

Parameters:

pFavoriteProductFeatures - - the favorite product features.

getDefaultCountry

public java.lang.String getDefaultCountry()

Returns:

the default country name.

setDefaultCountry

public void setDefaultCountry(java.lang.String pDefaultCountry)

Parameters:

pDefaultCountry - - the default country name to set.

getBackInStockFromAddress

public java.lang.String getBackInStockFromAddress()

Returns:

the sender's address for back in stock email messages.

setBackInStockFromAddress

public void setBackInStockFromAddress(java.lang.String pBackInStockFromAddress)

Parameters:

pBackInStockFromAddress - - the sender's address for back in stock email messages.

getCustomerServiceEmailAddress

public java.lang.String getCustomerServiceEmailAddress()

Returns:

customer service e-mail address.

setCustomerServiceEmailAddress

public void setCustomerServiceEmailAddress(java.lang.String pCustomerServiceEmailAddress)

Parameters:

pCustomerServiceEmailAddress - - the customer service e-mail address.

getGiftCertificateFromAddress

public java.lang.String getGiftCertificateFromAddress()

Returns:

the sernder's address for gift certificate delivery email messages.

setGiftCertificateFromAddress

public void setGiftCertificateFromAddress(java.lang.String pGiftCertificateFromAddress)

Parameters:

pGiftCertificateFromAddress - - the sender's address for gift certificate delivery email messages.

getNewPasswordFromAddress

public java.lang.String getNewPasswordFromAddress()

Returns:

the sender's address for new password email messages.

setNewPasswordFromAddress

public void setNewPasswordFromAddress(java.lang.String pNewPasswordFromAddress)

Parameters:

pNewPasswordFromAddress - - the sender's address for new password email messages.

getOrderConfirmationFromAddress

public java.lang.String getOrderConfirmationFromAddress()

Returns:

the sender's address for order confirmation email messages.

setOrderConfirmationFromAddress

public void setOrderConfirmationFromAddress(java.lang.String pOrderConfirmationFromAddress)

Parameters:

pOrderConfirmationFromAddress - - the sender's address for order confirmation email messages.

getOrderShippedFromAddress

public java.lang.String getOrderShippedFromAddress()

Returns:

the sender's address for order shipped email messages.

setOrderShippedFromAddress

public void setOrderShippedFromAddress(java.lang.String pOrderShippedFromAddress)

Parameters:

pOrderShippedFromAddress - - the sender's address for order shipped email messages.

getPromotionEmailAddress

public java.lang.String getPromotionEmailAddress()

Returns:

the recipient's address for promotionalContent with mailto links.

setPromotionEmailAddress

public void setPromotionEmailAddress(java.lang.String pPromotionEmailAddress)

Parameters:

pPromotionEmailAddress - - the recipient's address for promotionalContent with mailto links.

isRequireCreditCardVerification

public boolean isRequireCreditCardVerification()

This property determines if credit card verification numbers are required by the application.

Many credit cards have a card verification number printed, not embossed, on the card. This number is never transferred during card swipes and should be known only by the cardholder. Each card association has its own name for this number. Visa calls it the Card Verification Value (CVV2), and MasterCard calls it the Card Validation Code (CVC2). Visa and MasterCard print the number on the back of the card. American Express and Discover call it the Card Identification Digits (CID).

Returns:

Returns the requireCreditCardVerification.

setRequireCreditCardVerification

public void setRequireCreditCardVerification(boolean pRequireCreditCardVerification)

Parameters:

pRequireCreditCardVerification - - true if credit card verification is required, false - otherwise.

getDojoUrl

public java.lang.String getDojoUrl()

Returns:

the Dojo Url.

setDojoUrl

public void setDojoUrl(java.lang.String pDojoUrl)

Sets the DojoUrl - this is the full url that will be used as the src= attribute to include all dojo Javascript within the app.

Parameters:

pDojoUrl - - the DojoUrl to set.

isDojoDebug

public boolean isDojoDebug()

Enable dojo debugging?

Returns:

true to enable dojo debugging, false otherwise

setDojoDebug

public void setDojoDebug(boolean pDojoDebug)

Enables Dojo debug.

Parameters:

pDojoDebug - - the Dojo debug to set

getMandatoryStateCountryList

public java.util.List getMandatoryStateCountryList()

Returns:

the list of code of mandatory states.

setMandatoryStateCountryList

public void setMandatoryStateCountryList(java.util.List pMandatoryStateCountryList)

Parameters:

pMandatoryStateCountryList - - the List of code of mandatory states.

getNewProductThresholdDays

public long getNewProductThresholdDays()

Returns:

new product threshold days value.

setNewProductThresholdDays

public void setNewProductThresholdDays(long pNewProductThresholdDays)

Parameters:

pNewProductThresholdDays - - new product threshold days.

getDefaultPageSize

public java.lang.Integer getDefaultPageSize()

Gets products per page

Returns:

products per page

setDefaultPageSize

public void setDefaultPageSize(java.lang.Integer pDefaultPageSize)

Sets products per page

Parameters:

pDefaultPageSize - products per page