com.konakart.bl

Class BaseMgr

java.lang.Object

com.konakart.bl.BaseMgr

Direct Known Subclasses:

BasketMgr, BillingMgr, BookableProductMgr, CacheMgr, CategoryMgr, ConfigurationMgr, ContentMgr, CookieMgr, CurrencyMgr, CustomerMgr, CustomerStatsMgr, CustomerTagMgr, EmailMgr, EventMgr, ExportMgr, KKDBLockMgrEE, LanguageMgr, LDAPMgr, LoginIntegrationMgr, ManufacturerMgr, MiscItemMgr, MiscPriceMgr, MultiStoreMgr, OrderIntegrationMgr, OrderMgr, OrderTotalMgr, PaymentMgr, ProductMgr, PromotionMgr, PunchOutMgr, ReorderMgr, ReviewMgr, RewardPointMgr, SecurityMgr, ShippingMgr, SolrMgr, StoreMgr, SuggestionMgr, TaxMgr, VelocityContextMgr, VelocityMgr, WishListMgr

public class BaseMgr
extends java.lang.Object

Base Manager

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	templateBaseDir Velocity template base directory under WEB-INF/classes.

Constructor Summary

Constructors

Constructor and Description
BaseMgr()

Method Summary

Modifier and Type	Method and Description
protected boolean	acquireLock(java.lang.String lockName) Acquire a distributed lock if a KKLockMgrIf implementation is available
protected static void	addInsertAttr(org.apache.torque.util.Criteria c, java.lang.String attrName, int value) A utility method to not add integers that are equal to ConstantsMgr.NOT_SET
protected static void	addInsertAttr(org.apache.torque.util.Criteria c, java.lang.String attrName, java.lang.Object value) A utility to not add null objects
protected int	addStringRuleConstraint(KKCriteria c, java.lang.String searchValue, int searchRule, org.apache.torque.Column attrId) Add a String search constraint to the criteria.
protected int	addStringRuleConstraint(KKCriteria c, java.lang.String searchValue, int searchRule, java.lang.String attrId) Add a String search constraint to the criteria.
protected void	checkRequired(java.lang.Object param, java.lang.String paramType, java.lang.String paramName) Throws an exception with a proper message if the required parameter is null or null or empty for the case of a string.
java.lang.String	escapeHTML(java.lang.String input) Utility method to escape characters from a string.
protected java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String query) Execute query that works for all engine modes
protected java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, int start, int numberOfResults, java.lang.String dbName, boolean singleRecord) Method for performing a SELECT.
protected java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, int start, int numberOfResults, java.lang.String dbName, boolean singleRecord, boolean retryOnDeadlock, java.lang.String note) Method for performing a SELECT.
protected java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String queryString, int start, int numberOfResults, java.lang.String dbName, boolean singleRecord, boolean retryOnDeadlock, java.lang.String note, java.util.List<java.lang.Object> whereValues) Method for performing a SELECT.
protected java.util.List<com.workingdogs.village.Record>	executeQuery(java.lang.String query, java.util.List<java.lang.Object> whereValues) Execute query that works for all engine modes
protected AdminEngineMgrIf	getAdminEngMgr()
protected BasketMgrIf	getBasketMgr()
protected BillingMgrIf	getBillingMgr()
protected BookableProductMgrIf	getBookableProductMgr()
protected CacheMgrIf	getCacheMgr()
protected CategoryMgrIf	getCatMgr()
protected ConfigurationMgrIf	getConfigMgr()
protected CookieMgrIf	getCookieMgr()
protected CurrencyMgrIf	getCurrMgr()
protected CustomerMgrIf	getCustMgr()
protected int	getCustomerIdFromSession(java.lang.String sessionId) Throws an exception if the customer isn't valid.
protected CustomerStatsMgrIf	getCustomerStatsMgr()
protected CustomerTagMgrIf	getCustomerTagMgr()
protected EmailMgrIf	getEmailMgr()
KKEngIf	getEng()
protected EventMgrIf	getEventMgr()
protected ExportMgrIf	getExportMgr()
com.google.common.escape.Escaper	getHTMLEscaper() Returns the HTML Escaper
protected boolean	getKonaKartConfig(java.lang.String key, boolean def) Get a property from konakart.properties as a boolean.
protected int	getKonaKartConfig(java.lang.String key, int def) Get a property from konakart.properties as an integer.
protected long	getKonaKartConfig(java.lang.String key, long def) Get a property from konakart.properties as a long integer.
protected LanguageMgrIf	getLangMgr()
protected ManufacturerMgrIf	getManuMgr()
protected MiscItemMgrIf	getMiscItemMgr()
protected MiscPriceMgrIf	getMiscPriceMgr()
protected int	getMode() Return the engine mode
protected java.lang.String	getModeString() Return the engine mode - as a descriptive String for diagnostic purposes only
protected MqMgrIf	getMqMgr()
protected MultiStoreMgrIf	getMultiStoreMgr()
protected KKCriteria	getNewCriteria() Gets a new KKCriteria object
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 OrderIntegrationMgrInterface	getOrderIntegrationMgr() Used to get an instance of the OrderIntegrationMgr
protected OrderMgrIf	getOrderMgr()
protected OrderTotalMgrIf	getOrderTotalMgr()
protected PaymentMgrIf	getPaymentMgr()
protected ProductMgrIf	getProdMgr()
protected KKCriteria	getProductsToCategoresCriteria() Gets a new KKCriteria object for use with ProductsToCategories.
protected PromotionMgrIf	getPromMgr()
protected PunchOutMgrIf	getPunchOutMgr()
protected RewardPointMgrIf	getRewardPointMgr()
protected SecurityMgrIf	getSecMgr()
protected ShippingMgrIf	getShippingMgr()
protected SolrMgrIf	getSolrMgr()
protected java.lang.String	getStoreId() Return the storeId
protected StoreMgrIf	getStoreMgr()
protected java.util.Date	getStoreTime() Returns the local store time based on the tz database time zone of the store.
protected SuggestionMgrIf	getSuggestionMgr()
protected TaxMgrIf	getTaxMgr()
protected org.apache.velocity.Template	getTemplate(org.apache.velocity.app.VelocityEngine ve, java.lang.String configDir, java.lang.String templateName) Helper method to search for the velocity templates in the correct sub-directory within the class path.
protected java.lang.String	getTemplateRoot(java.lang.String configDir) Returns the template base directory which is created by concatenating the following: Value of the Directory configuration variable specified current storeId
protected VelocityContextMgrIf	getVelocityContextMgr()
protected WishListMgrIf	getWishListMgr()
protected void	init(KKEngIf kkEng, org.apache.commons.logging.Log logger) Init method called from the super class.
protected int	insertKKEvent(int code, int subCode, int intValue)
protected int	insertKKEvent(int code, int subCode, java.lang.String value)
protected boolean	isBusiness() Returns true if we are in Business Mode
protected boolean	isBusinessOrEnterprise() Returns true if we are in Business or Enterprise Mode
protected boolean	isClassPresent(java.lang.String className) Check whether the specified class is present on the classpath.
protected boolean	isCommunity() Returns true if we are in Community Mode
protected boolean	isDeadlockException(java.sql.SQLException se)
protected boolean	isEnterprise() Returns true if we are in Enterprise Mode
protected boolean	isMultiStoreShareCategories() Returns true if we can share categories in multi-store single db mode.
protected boolean	isMultiStoreShareCustomers() Returns true if we need to share customers in multi-store single db mode
protected boolean	isMultiStoreShareCustomersOrProducts() Returns true if we need to share customers or products in multi-store single db mode
protected boolean	isMultiStoreSharedDb() Returns true if we are running in Multi-Store Shared DB mode
protected boolean	isMultiStoreShareProducts() Returns true if we can share products in multi-store single db mode
boolean	isMultiVendor() Returns true if the store is in multi-vendor mode
protected boolean	isUnix() Is a UNIX-like operating system?
protected com.konakart.app.KKException	manageThrowable(java.lang.Throwable e) Common code to manage exceptions in the Managers
protected boolean	releaseLock(java.lang.String lockName) Release a distributed lock if a KKLockMgrIf implementation is available
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

templateBaseDir

protected java.lang.String templateBaseDir

Velocity template base directory under WEB-INF/classes. It can be cached globally since it has the same value for all stores

Constructor Detail

BaseMgr

public BaseMgr()

Method Detail

init

protected void init(KKEngIf kkEng,
                    org.apache.commons.logging.Log logger)
             throws java.lang.Exception

Init method called from the super class.

Parameters:

kkEng - the kkEng

logger - the logger

Throws:

java.lang.Exception - an unexpected exception

getKonaKartConfig

protected boolean getKonaKartConfig(java.lang.String key,
                                    boolean def)

Get a property from konakart.properties as a boolean. A default value is returned if the property or properties file can't be found.

Parameters:

key - key in the properties file (do not add "konakart." at the start)

def - default value to return if the property or properties file isn't found

Returns:

the boolean value of the property in the konakart.properties file or the default value if it can't be found

getKonaKartConfig

protected int getKonaKartConfig(java.lang.String key,
                                int def)

Get a property from konakart.properties as an integer. A default value is returned if the property or properties file can't be found or the value found cannot be converted to an integer.

Parameters:

key - key in the properties file (do not add "konakart." at the start)

def - default value to return if the property or properties file isn't found

Returns:

the integer value of the property in the konakart.properties file or the default value if it can't be found

getKonaKartConfig

protected long getKonaKartConfig(java.lang.String key,
                                 long def)

Get a property from konakart.properties as a long integer. A default value is returned if the property or properties file can't be found or the value found cannot be converted to an integer.

Parameters:

key - key in the properties file (do not add "konakart." at the start)

def - default value to return if the property or properties file isn't found

Returns:

the long integer value of the property in the konakart.properties file or the default value if it can't be found

insertKKEvent

protected int insertKKEvent(int code,
                            int subCode,
                            int intValue)
                     throws java.lang.Exception

Parameters:

code - the code

subCode - the subCode

intValue - the intValue

Returns:

Returns the id of the newly-inserted Event

Throws:

java.lang.Exception - an unexpected exception

insertKKEvent

protected int insertKKEvent(int code,
                            int subCode,
                            java.lang.String value)
                     throws java.lang.Exception

Parameters:

code - the code

subCode - the subCode

value - the value

Returns:

Returns the id of the newly-inserted Event

Throws:

java.lang.Exception - an unexpected exception

getWishListMgr

protected WishListMgrIf getWishListMgr()
                                throws java.lang.Exception

Returns:

Returns the WishListMgr

Throws:

java.lang.Exception - an unexpected exception

getTaxMgr

protected TaxMgrIf getTaxMgr()
                      throws java.lang.Exception

Returns:

Returns the TaxMgr

Throws:

java.lang.Exception - an unexpected exception

getLangMgr

protected LanguageMgrIf getLangMgr()
                            throws java.lang.Exception

Returns:

Returns the LanguageMgr

Throws:

java.lang.Exception - an unexpected exception

getCustMgr

protected CustomerMgrIf getCustMgr()
                            throws java.lang.Exception

Returns:

Returns the CustomerMgr

Throws:

java.lang.Exception - an unexpected exception

getConfigMgr

protected ConfigurationMgrIf getConfigMgr()
                                   throws java.lang.Exception

Returns:

Returns the ConfigurationMgr

Throws:

java.lang.Exception - an unexpected exception

getProdMgr

protected ProductMgrIf getProdMgr()
                           throws java.lang.Exception

Returns:

Returns the ProductMgr

Throws:

java.lang.Exception - an unexpected exception

getCurrMgr

protected CurrencyMgrIf getCurrMgr()
                            throws java.lang.Exception

Returns:

Returns the CurrencyMgr

Throws:

java.lang.Exception - an unexpected exception

getSecMgr

protected SecurityMgrIf getSecMgr()
                           throws java.lang.Exception

Returns:

Returns the SecurityMgr

Throws:

java.lang.Exception - an unexpected exception

getCatMgr

protected CategoryMgrIf getCatMgr()
                           throws java.lang.Exception

Returns:

Returns the CategoryMgr

Throws:

java.lang.Exception - an unexpected exception

getCacheMgr

protected CacheMgrIf getCacheMgr()
                          throws java.lang.Exception

Returns:

Returns the CacheMgr

Throws:

java.lang.Exception - an unexpected exception

getEmailMgr

protected EmailMgrIf getEmailMgr()
                          throws java.lang.Exception

Returns:

Returns the EmailMgr

Throws:

java.lang.Exception - an unexpected exception

getManuMgr

protected ManufacturerMgrIf getManuMgr()
                                throws java.lang.Exception

Returns:

Returns the ManufacturerMgr

Throws:

java.lang.Exception - an unexpected exception

getVelocityContextMgr

protected VelocityContextMgrIf getVelocityContextMgr()
                                              throws java.lang.Exception

Returns:

Returns the VelocityContextMgr

Throws:

java.lang.Exception - an unexpected exception

getOrderMgr

protected OrderMgrIf getOrderMgr()
                          throws java.lang.Exception

Returns:

Returns the OrderMgr

Throws:

java.lang.Exception - an unexpected exception

getPromMgr

protected PromotionMgrIf getPromMgr()
                             throws java.lang.Exception

Returns:

Returns the PromotionMgr

Throws:

java.lang.Exception - an unexpected exception

getBasketMgr

protected BasketMgrIf getBasketMgr()
                            throws java.lang.Exception

Returns:

Returns the BasketMgr

Throws:

java.lang.Exception - an unexpected exception

getExportMgr

protected ExportMgrIf getExportMgr()
                            throws java.lang.Exception

Returns:

Returns the ExportMgr

Throws:

java.lang.Exception - an unexpected exception

getCookieMgr

protected CookieMgrIf getCookieMgr()
                            throws java.lang.Exception

Returns:

Returns the CookieMgr

Throws:

java.lang.Exception - an unexpected exception

getShippingMgr

protected ShippingMgrIf getShippingMgr()
                                throws java.lang.Exception

Returns:

Returns the ShippingMgr

Throws:

java.lang.Exception - an unexpected exception

getPaymentMgr

protected PaymentMgrIf getPaymentMgr()
                              throws java.lang.Exception

Returns:

Returns the PaymentMgr

Throws:

java.lang.Exception - an unexpected exception

getOrderTotalMgr

protected OrderTotalMgrIf getOrderTotalMgr()
                                    throws java.lang.Exception

Returns:

Returns the OrderTotalMgr

Throws:

java.lang.Exception - an unexpected exception

getStoreMgr

protected StoreMgrIf getStoreMgr()
                          throws java.lang.Exception

Returns:

Returns the StoreMgr

Throws:

java.lang.Exception - an unexpected exception

getSolrMgr

protected SolrMgrIf getSolrMgr()
                        throws java.lang.Exception

Returns:

Returns the SolrMgr

Throws:

java.lang.Exception - an unexpected exception

getEventMgr

protected EventMgrIf getEventMgr()
                          throws java.lang.Exception

Returns:

Returns the EventMgr

Throws:

java.lang.Exception - an unexpected exception

getPunchOutMgr

protected PunchOutMgrIf getPunchOutMgr()
                                throws java.lang.Exception

Returns:

Returns the PunchOutMgr

Throws:

java.lang.Exception - an unexpected exception

getMiscItemMgr

protected MiscItemMgrIf getMiscItemMgr()
                                throws java.lang.Exception

Returns:

Returns the MiscItemMgr

Throws:

java.lang.Exception - an unexpected exception

getMiscPriceMgr

protected MiscPriceMgrIf getMiscPriceMgr()
                                  throws java.lang.Exception

Returns:

Returns the MiscPriceMgr

Throws:

java.lang.Exception - an unexpected exception

getMultiStoreMgr

protected MultiStoreMgrIf getMultiStoreMgr()

Returns:

Returns the MultiStoreMgr

getCustomerTagMgr

protected CustomerTagMgrIf getCustomerTagMgr()
                                      throws java.lang.Exception

Returns:

Returns the CustomerTagMgr

Throws:

java.lang.Exception - an unexpected exception

getCustomerStatsMgr

protected CustomerStatsMgrIf getCustomerStatsMgr()
                                          throws java.lang.Exception

Returns:

Returns the CustomerStatsMgr

Throws:

java.lang.Exception - an unexpected exception

getBillingMgr

protected BillingMgrIf getBillingMgr()
                              throws java.lang.Exception

Returns:

Returns the BillingMgr

Throws:

java.lang.Exception - an unexpected exception

getBookableProductMgr

protected BookableProductMgrIf getBookableProductMgr()
                                              throws java.lang.Exception

Returns:

Returns the BookableProductMgr

Throws:

java.lang.Exception - an unexpected exception

getRewardPointMgr

protected RewardPointMgrIf getRewardPointMgr()
                                      throws java.lang.Exception

Returns:

Returns the RewardPointMgr

Throws:

java.lang.Exception - an unexpected exception

getAdminEngMgr

protected AdminEngineMgrIf getAdminEngMgr()
                                   throws java.lang.Exception

Returns:

Returns the AdminEngineMgr

Throws:

java.lang.Exception - an unexpected exception

getMqMgr

protected MqMgrIf getMqMgr()
                    throws java.lang.Exception

Returns:

Returns the MqMgr

Throws:

java.lang.Exception - an unexpected exception

getSuggestionMgr

protected SuggestionMgrIf getSuggestionMgr()
                                    throws java.lang.Exception

Returns:

Returns the SuggestionMgr

Throws:

java.lang.Exception - an unexpected exception

addInsertAttr

protected static void addInsertAttr(org.apache.torque.util.Criteria c,
                                    java.lang.String attrName,
                                    int value)

A utility method to not add integers that are equal to ConstantsMgr.NOT_SET

Parameters:

c - the c

attrName - the attrName

value - the value

addInsertAttr

protected static void addInsertAttr(org.apache.torque.util.Criteria c,
                                    java.lang.String attrName,
                                    java.lang.Object value)

A utility to not add null objects

Parameters:

c - the c

attrName - the attrName

value - the value

checkRequired

protected void checkRequired(java.lang.Object param,
                             java.lang.String paramType,
                             java.lang.String paramName)
                      throws com.konakart.app.KKException

Throws an exception with a proper message if the required parameter is null or null or empty for the case of a string.

Parameters:

param - the param

paramType - the paramType

paramName - the paramName

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getCustomerIdFromSession

protected int getCustomerIdFromSession(java.lang.String sessionId)
                                throws java.lang.Exception

Throws an exception if the customer isn't valid. Otherwise it returns the customerId.

Parameters:

sessionId - the sessionId

Returns:

Returns the customerId if it is that of a valid customer

Throws:

java.lang.Exception - an unexpected exception

getEng

public KKEngIf getEng()

Returns:

Returns the eng.

getMode

protected int getMode()
               throws com.konakart.app.KKException

Return the engine mode

Returns:

Return the engine mode

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getModeString

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

Return the engine mode - as a descriptive String for diagnostic purposes only

Returns:

Return the engine mode as a descriptive String

Throws:

com.konakart.app.KKException - an unexpected KKException exception

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 KKException exception

getNewCriteria

protected KKCriteria getNewCriteria()

Gets a new KKCriteria object

Returns:

Returns a new KKCriteria object

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

getProductsToCategoresCriteria

protected KKCriteria getProductsToCategoresCriteria()

Gets a new KKCriteria object for use with ProductsToCategories.

Returns:

Returns a new KKCriteria object for use with ProductsToCategores queries

isBusinessOrEnterprise

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

Returns true if we are in Business or Enterprise Mode

Returns:

true for Business or Enterprise Mode

Throws:

com.konakart.app.KKException - if the engine config has not yet been defined

isEnterprise

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

Returns true if we are in Enterprise Mode

Returns:

true for Enterprise Mode

Throws:

com.konakart.app.KKException - if the engine config has not yet been defined

isCommunity

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

Returns true if we are in Community Mode

Returns:

true for Community Mode

Throws:

com.konakart.app.KKException - if the engine config has not yet been defined

isBusiness

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

Returns true if we are in Business Mode

Returns:

true for Business Mode

Throws:

com.konakart.app.KKException - if the engine config has not yet been defined

isUnix

protected boolean isUnix()

Is a UNIX-like operating system?

Returns:

true if this is a UNIX-like operating system

isMultiStoreSharedDb

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

Returns true if we are running in Multi-Store Shared DB mode

Returns:

true if running in multi-store shared db mode

Throws:

com.konakart.app.KKException - an unexpected KKException exception

isMultiStoreShareCustomers

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

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

Returns:

the multiStoreShareCustomers

Throws:

com.konakart.app.KKException - an unexpected KKException exception

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 KKException exception

isMultiStoreShareProducts

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

Returns true if we can share products in multi-store single db mode

Returns:

Returns true if we can share products in multi-store single db mode

Throws:

com.konakart.app.KKException - an unexpected KKException exception

isMultiVendor

public boolean isMultiVendor()
                      throws java.lang.Exception

Returns true if the store is in multi-vendor mode

Returns:

Returns true if the store is in multi-vendor mode

Throws:

java.lang.Exception - an unexpected exception

isMultiStoreShareCategories

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

Returns true if we can share categories in multi-store single db mode. Shared Category mode is only available if products are shared.

Returns:

Returns true if we can share categories in multi-store single db mode

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getTemplate

protected org.apache.velocity.Template getTemplate(org.apache.velocity.app.VelocityEngine ve,
                                                   java.lang.String configDir,
                                                   java.lang.String templateName)
                                            throws org.apache.velocity.exception.ResourceNotFoundException,
                                                   org.apache.velocity.exception.ParseErrorException,
                                                   com.konakart.app.KKException,
                                                   java.lang.Exception

Helper method to search for the velocity templates in the correct sub-directory within the class path.

If the template isn't found, we try to find it using the default country code and write an error in the log so that the administrator is aware that the template doesn't exist.

Parameters:

ve - the ve

configDir - the configuration parameter that defines the root directory for the template

templateName - the templateName

Returns:

Returns the Velocity Template

Throws:

java.lang.Exception - an unexpected exception

com.konakart.app.KKException - an unexpected KKException exception

org.apache.velocity.exception.ParseErrorException - an unexpected ParseErrorException exception

org.apache.velocity.exception.ResourceNotFoundException - an unexpected ResourceNotFoundException exception

getTemplateRoot

protected java.lang.String getTemplateRoot(java.lang.String configDir)
                                    throws org.apache.torque.TorqueException,
                                           com.konakart.app.KKException,
                                           com.workingdogs.village.DataSetException,
                                           java.lang.Exception

Returns the template base directory which is created by concatenating the following:

• Value of the Directory configuration variable specified
• current storeId

If the config variable isn't available, a default value of the current directory is returned.

Parameters:

configDir - the configuration parameter that defines the root directory for the template

Returns:

Returns Returns the template base directory.

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

java.lang.Exception - an unexpected exception

getOrderIntegrationMgr

protected OrderIntegrationMgrInterface getOrderIntegrationMgr()
                                                       throws org.apache.torque.TorqueException,
                                                              com.konakart.app.KKException,
                                                              com.workingdogs.village.DataSetException,
                                                              java.lang.Exception

Used to get an instance of the OrderIntegrationMgr

Returns:

Returns an OrderIntegrationMgr Object

Throws:

java.lang.Exception - an unexpected exception

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

executeQuery

protected java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String query)
                                                               throws org.apache.torque.TorqueException,
                                                                      com.konakart.app.KKException

Execute query that works for all engine modes

Parameters:

query - the query

Returns:

the result of the query

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

executeQuery

protected java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String query,
                                                                      java.util.List<java.lang.Object> whereValues)
                                                               throws org.apache.torque.TorqueException,
                                                                      com.konakart.app.KKException

Execute query that works for all engine modes

Parameters:

query - the query

whereValues - the whereValues

Returns:

the result of the query

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

com.konakart.app.KKException - an unexpected KKException exception

executeQuery

protected java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                      int start,
                                                                      int numberOfResults,
                                                                      java.lang.String dbName,
                                                                      boolean singleRecord)
                                                               throws org.apache.torque.TorqueException

Method for performing a SELECT.

Parameters:

queryString - A String with the sql statement to execute.

start - The first row to return.

numberOfResults - The number of rows to return.

dbName - The database to connect to.

singleRecord - Whether or not we want to select only a single record.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer) Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

executeQuery

protected java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                      int start,
                                                                      int numberOfResults,
                                                                      java.lang.String dbName,
                                                                      boolean singleRecord,
                                                                      boolean retryOnDeadlock,
                                                                      java.lang.String note)
                                                               throws org.apache.torque.TorqueException

Method for performing a SELECT.

Parameters:

queryString - A String with the sql statement to execute.

start - The first row to return.

numberOfResults - The number of rows to return.

dbName - The database to connect to.

singleRecord - Whether or not we want to select only a single record.

retryOnDeadlock - if true the query is retried in the event of deadlock detection

note - For problem diagnosis only. This note is added to a warning message to help identify the source of the deadlock.

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer) Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

executeQuery

protected java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String queryString,
                                                                      int start,
                                                                      int numberOfResults,
                                                                      java.lang.String dbName,
                                                                      boolean singleRecord,
                                                                      boolean retryOnDeadlock,
                                                                      java.lang.String note,
                                                                      java.util.List<java.lang.Object> whereValues)
                                                               throws org.apache.torque.TorqueException

Method for performing a SELECT.

Parameters:

queryString - A String with the sql statement to execute.

start - The first row to return.

numberOfResults - The number of rows to return.

dbName - The database to connect to.

singleRecord - Whether or not we want to select only a single record.

retryOnDeadlock - if true the query is retried in the event of deadlock detection

note - For problem diagnosis only. This note is added to a warning message to help identify the source of the deadlock.

whereValues - the where clause values used in prepared statements

Returns:

List of Record objects.

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer) Any exceptions caught during processing will be re-thrown wrapped into a TorqueException.

isDeadlockException

protected boolean isDeadlockException(java.sql.SQLException se)

Parameters:

se - a java.sql.SQLException

Returns:

Returns true if it is a deadlock exception

addStringRuleConstraint

protected int addStringRuleConstraint(KKCriteria c,
                                      java.lang.String searchValue,
                                      int searchRule,
                                      java.lang.String attrId)

Add a String search constraint to the criteria.

Parameters:

c - the Criteria

searchValue - value to use in the search

searchRule - rule

attrId - the BasePeer attribute name

Returns:

Returns the number of constraints added (will be 1 or 0)

addStringRuleConstraint

protected int addStringRuleConstraint(KKCriteria c,
                                      java.lang.String searchValue,
                                      int searchRule,
                                      org.apache.torque.Column attrId)

Add a String search constraint to the criteria.

Parameters:

c - the Criteria

searchValue - value to use in the search

searchRule - rule

attrId - the BasePeer attribute name

Returns:

Returns the number of constraints added (will be 1 or 0)

manageThrowable

protected com.konakart.app.KKException manageThrowable(java.lang.Throwable e)

Common code to manage exceptions in the Managers

Parameters:

e - the e

Returns:

a new KKException if the exception specified is not already a KKException

getStoreTime

protected java.util.Date getStoreTime()
                               throws java.lang.Exception

Returns the local store time based on the tz database time zone of the store. A list can be found here: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones . They are in a string format and look like US/Pacific, Australia/Perth, Europe/London etc. and observe DST.

Returns:

Returns a Date object for the current store time

Throws:

java.lang.Exception - an unexpected exception

escapeHTML

public java.lang.String escapeHTML(java.lang.String input)

Utility method to escape characters from a string. The characters are defined in the properties file under the key konakart.escape.chars

Parameters:

input - the input

Returns:

Returns the escaped string

getHTMLEscaper

public com.google.common.escape.Escaper getHTMLEscaper()

Returns the HTML Escaper

Returns:

Returns the HTML Escaper

releaseLock

protected boolean releaseLock(java.lang.String lockName)

Release a distributed lock if a KKLockMgrIf implementation is available

Parameters:

lockName - the lockName

Returns:

true if a lock was released

acquireLock

protected boolean acquireLock(java.lang.String lockName)
                       throws com.konakart.app.KKException

Acquire a distributed lock if a KKLockMgrIf implementation is available

Parameters:

lockName - the lockName

Returns:

true if a lock was acquired

Throws:

com.konakart.app.KKException - an unexpected KKException exception

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

isClassPresent

protected boolean isClassPresent(java.lang.String className)

Check whether the specified class is present on the classpath. The class is not instantiated.

Parameters:

className - the class name

Returns:

true if the class is present otherwise false