com.konakart.bl.modules

Class BaseModule

java.lang.Object

com.konakart.bl.modules.BaseModule

Direct Known Subclasses:

BaseMailModule, BaseOrderTotalModule, BasePaymentModule, BaseShippingModule, Captcha, USPSAddrVal

public class BaseModule
extends java.lang.Object

Base class for all modules.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	basePackage Base package
protected static java.lang.String	debugStackTraceExclusions For excluding lines from debug stack traces - to eliminate unhelpful information

Constructor Summary

Constructors

Constructor and Description
BaseModule()

Method Summary

Modifier and Type	Method and Description
protected BasketMgrIf	getBasketMgr()
protected CategoryMgrIf	getCatMgr()
protected ConfigurationMgrIf	getConfigMgr()
protected KKConfiguration	getConfiguration(java.lang.String key)
protected java.lang.String	getConfigurationValue(java.lang.String key)
protected java.math.BigDecimal	getConfigurationValueAsBigDecimalWithDefault(java.lang.String key, java.math.BigDecimal def)
protected boolean	getConfigurationValueAsBool(java.lang.String key, boolean def)
protected int	getConfigurationValueAsIntWithDefault(java.lang.String key, int def)
protected CurrencyMgrIf	getCurrMgr()
protected CustomerMgrIf	getCustMgr()
protected CustomerTagMgrIf	getCustTagMgr()
protected static java.lang.String	getDebugStackTraceExclusions()
protected EmailMgrIf	getEmailMgr()
protected KKEng	getEng()
protected LanguageMgrIf	getLangMgr()
java.lang.String	getModuleClassName() Gets the name of the module class.
protected MultiStoreMgrIf	getMultiStoreMgr()
protected KKCriteria	getNewCriteria(boolean allStores) Gets a new KKCriteria object with the option of it being for all stores when in multi-store single db mode.
protected OrderMgrIf	getOrderMgr()
protected OrderTotalMgrIf	getOrderTotalMgr()
protected PaymentMgrIf	getPaymentMgr()
protected ProductMgrIf	getProdMgr()
protected PromotionMgrIf	getPromMgr()
protected java.lang.String	getRandomText(int length) Returns a random String of the length specified
protected java.lang.String	getRandomText(java.lang.String allowedChars, int length) Returns a random String of the length specified choosing only characters from the allowedChars String
protected java.util.ResourceBundle	getResourceBundle(java.lang.String mutex, java.lang.String bundleName, java.util.HashMap<java.util.Locale,java.util.ResourceBundle> resourceBundleMap, java.util.Locale locale) The resource bundle is fetched for the locale and stored in a static hash table.
protected RewardPointMgrIf	getRewardPointMgr()
protected SecurityMgrIf	getSecMgr()
protected ShippingMgrIf	getShippingMgr()
protected SolrMgrIf	getSolrMgr()
protected java.lang.String	getStoreId() Return the storeId
protected StoreMgrIf	getStoreMgr()
protected TaxMgrIf	getTaxMgr()
protected java.lang.String	getZoneCodeForZoneName(java.lang.String zoneNameStr) Try to find the zone code for the specified zone name.
protected void	init(KKEngIf engine) Init method called from the super class.
protected boolean	isAvailable(KKEng engine, java.lang.String configKey) Called to determine whether the module is available
protected boolean	isAvailable(java.lang.String configKey) Called to determine whether the module is available
protected boolean	isMultiStoreShareCustomersOrProducts() Returns true if we need to share customers or products in multi-store single db mode
protected static void	setDebugStackTraceExclusions(java.lang.String debugStackTraceExclusions)
protected boolean	updateStaticVariablesNow(long lastUpdatedMS) Checks whether we should update the static variables now given the last updated was as specified.

Methods inherited from class java.lang.Object

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

Field Detail

basePackage

public static final java.lang.String basePackage

Base package

See Also:

Constant Field Values

debugStackTraceExclusions

protected static java.lang.String debugStackTraceExclusions

For excluding lines from debug stack traces - to eliminate unhelpful information

Constructor Detail

BaseModule

public BaseModule()

Method Detail

init

protected void init(KKEngIf engine)

Init method called from the super class.

Parameters:

engine - a KKEngIf engine

updateStaticVariablesNow

protected boolean updateStaticVariablesNow(long lastUpdatedMS)

Checks whether we should update the static variables now given the last updated was as specified.

Parameters:

lastUpdatedMS - the last time the static variables were updated (using system time)

Returns:

true to go ahead and update the static variables now, otherwise false

getResourceBundle

protected java.util.ResourceBundle getResourceBundle(java.lang.String mutex,
                                                     java.lang.String bundleName,
                                                     java.util.HashMap<java.util.Locale,java.util.ResourceBundle> resourceBundleMap,
                                                     java.util.Locale locale)
                                              throws com.konakart.app.KKException

The resource bundle is fetched for the locale and stored in a static hash table. Next time around it is retrieved from the hash table.

Parameters:

mutex - the mutex

bundleName - the bundleName

resourceBundleMap - the resourceBundleMap

locale - the locale

Returns:

The resource bundle referenced by the locale

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

isAvailable

protected boolean isAvailable(KKEng engine,
                              java.lang.String configKey)
                       throws com.konakart.app.KKException

Called to determine whether the module is available

Parameters:

engine - the KonaKart Engine

configKey - the configuration key

Returns:

Returns true or false

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

isAvailable

protected boolean isAvailable(java.lang.String configKey)
                       throws com.konakart.app.KKException

Called to determine whether the module is available

Parameters:

configKey - the configuration key

Returns:

Returns true or false

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

getStoreId

protected java.lang.String getStoreId()
                               throws com.konakart.app.KKException

Return the storeId

Returns:

Return the storeId

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

getConfiguration

protected KKConfiguration getConfiguration(java.lang.String key)
                                    throws com.konakart.app.KKException

Parameters:

key - the configuration key

Returns:

Returns the KKConfiguration object

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

getConfigurationValue

protected java.lang.String getConfigurationValue(java.lang.String key)
                                          throws com.konakart.app.KKException

Parameters:

key - the configuration key

Returns:

Returns the String value of the configuration variable

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

getConfigurationValueAsBool

protected boolean getConfigurationValueAsBool(java.lang.String key,
                                              boolean def)
                                       throws com.konakart.app.KKException

Parameters:

key - the configuration key

def - the default value that is used if the key isn't found

Returns:

Returns the boolean value of the configuration variable

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

getConfigurationValueAsIntWithDefault

protected int getConfigurationValueAsIntWithDefault(java.lang.String key,
                                                    int def)
                                             throws com.konakart.app.KKException

Parameters:

key - the configuration key

def - the default value that is used if the key isn't found

Returns:

Returns the int value of the configuration variable

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

getConfigurationValueAsBigDecimalWithDefault

protected java.math.BigDecimal getConfigurationValueAsBigDecimalWithDefault(java.lang.String key,
                                                                            java.math.BigDecimal def)
                                                                     throws com.konakart.app.KKException

Parameters:

key - the configuration key

def - the default value that is used if the key isn't found

Returns:

Returns the BigDecimal value of the configuration variable

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

getZoneCodeForZoneName

protected java.lang.String getZoneCodeForZoneName(java.lang.String zoneNameStr)

Try to find the zone code for the specified zone name.

Parameters:

zoneNameStr - the zone name to find

Returns:

the zone code for the specified zone name or the zone name string that was specified if it can't be found. If more than one zone with the specified name is found we loop through the matching zones found and return the first non-null zone code that is found.

getEng

protected KKEng getEng()

Returns:

Returns the engine instance

getTaxMgr

protected TaxMgrIf getTaxMgr()
                      throws java.lang.Exception

Returns:

return the Tax Manager

Throws:

java.lang.Exception - an unexpected exception

getLangMgr

protected LanguageMgrIf getLangMgr()
                            throws java.lang.Exception

Returns:

return the Language Manager

Throws:

java.lang.Exception - an unexpected exception

getCustMgr

protected CustomerMgrIf getCustMgr()
                            throws java.lang.Exception

Returns:

return the Customer Manager

Throws:

java.lang.Exception - an unexpected exception

getCustTagMgr

protected CustomerTagMgrIf getCustTagMgr()
                                  throws java.lang.Exception

Returns:

return the Customer Tag Manager

Throws:

java.lang.Exception - an unexpected exception

getConfigMgr

protected ConfigurationMgrIf getConfigMgr()
                                   throws java.lang.Exception

Returns:

return the Configuration Manager

Throws:

java.lang.Exception - an unexpected exception

getProdMgr

protected ProductMgrIf getProdMgr()
                           throws java.lang.Exception

Returns:

return the Product Manager

Throws:

java.lang.Exception - an unexpected exception

getCurrMgr

protected CurrencyMgrIf getCurrMgr()
                            throws java.lang.Exception

Returns:

return the Currency Manager

Throws:

java.lang.Exception - an unexpected exception

getSecMgr

protected SecurityMgrIf getSecMgr()
                           throws java.lang.Exception

Returns:

Return the Security Manager

Throws:

java.lang.Exception - an unexpected exception

getCatMgr

protected CategoryMgrIf getCatMgr()
                           throws java.lang.Exception

Returns:

Return the Category Manager

Throws:

java.lang.Exception - an unexpected exception

getEmailMgr

protected EmailMgrIf getEmailMgr()
                          throws java.lang.Exception

Returns:

Return the Email Manager

Throws:

java.lang.Exception - an unexpected exception

getOrderMgr

protected OrderMgrIf getOrderMgr()
                          throws java.lang.Exception

Returns:

Return the Order Manager

Throws:

java.lang.Exception - an unexpected exception

getPromMgr

protected PromotionMgrIf getPromMgr()
                             throws java.lang.Exception

Returns:

Return the Promotion Manager

Throws:

java.lang.Exception - an unexpected exception

getBasketMgr

protected BasketMgrIf getBasketMgr()
                            throws java.lang.Exception

Returns:

Return the Basket Manager

Throws:

java.lang.Exception - an unexpected exception

getShippingMgr

protected ShippingMgrIf getShippingMgr()
                                throws java.lang.Exception

Returns:

Return the Shipping Manager

Throws:

java.lang.Exception - an unexpected exception

getPaymentMgr

protected PaymentMgrIf getPaymentMgr()
                              throws java.lang.Exception

Returns:

Return the Payment Manager

Throws:

java.lang.Exception - an unexpected exception

getOrderTotalMgr

protected OrderTotalMgrIf getOrderTotalMgr()
                                    throws java.lang.Exception

Returns:

Return the Order Total Manager

Throws:

java.lang.Exception - an unexpected exception

getSolrMgr

protected SolrMgrIf getSolrMgr()
                        throws java.lang.Exception

Returns:

Return the Solr Manager

Throws:

java.lang.Exception - an unexpected exception

getMultiStoreMgr

protected MultiStoreMgrIf getMultiStoreMgr()

Returns:

Return the Multi Store Manager

getRewardPointMgr

protected RewardPointMgrIf getRewardPointMgr()
                                      throws java.lang.Exception

Returns:

Return the Reward Point Manager

Throws:

java.lang.Exception - an unexpected exception

getStoreMgr

protected StoreMgrIf getStoreMgr()
                          throws java.lang.Exception

Returns:

Return the Store Manager

Throws:

java.lang.Exception - an unexpected exception

getRandomText

protected java.lang.String getRandomText(int length)

Returns a random String of the length specified

Parameters:

length - the length

Returns:

a random String of the length specified

getRandomText

protected java.lang.String getRandomText(java.lang.String allowedChars,
                                         int length)

Returns a random String of the length specified choosing only characters from the allowedChars String

Parameters:

allowedChars - a String containing the set of characters that can be used

length - the length

Returns:

a random String of the length specified

getNewCriteria

protected KKCriteria getNewCriteria(boolean allStores)

Gets a new KKCriteria object with the option of it being for all stores when in multi-store single db mode.

Parameters:

allStores - the allStores

Returns:

Returns a new KKCriteria object

isMultiStoreShareCustomersOrProducts

protected boolean isMultiStoreShareCustomersOrProducts()
                                                throws com.konakart.app.KKException

Returns true if we need to share customers or products in multi-store single db mode

Returns:

true if we're sharing customers or products

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

getModuleClassName

public java.lang.String getModuleClassName()

Gets the name of the module class.

Returns:

the module's class name.

getDebugStackTraceExclusions

protected static java.lang.String getDebugStackTraceExclusions()

Returns:

the debugStackTraceExclusions

setDebugStackTraceExclusions

protected static void setDebugStackTraceExclusions(java.lang.String debugStackTraceExclusions)

Parameters:

debugStackTraceExclusions - the debugStackTraceExclusions to set