AdminBaseMgr (KonaKartAdmin API Documentation)

java.lang.Object
- com.konakartadmin.bl.AdminBaseMgr

Direct Known Subclasses:

AdminAddressMgr, AdminAuditMgr, AdminBasePayment, AdminBatchBaseMgr, AdminBillingMgr, AdminBookableProductMgr, AdminCategoryMgr, AdminCommunityStoreMgr, AdminConfigurationMgr, AdminContentMgr, AdminCurrencyMgr, AdminCustomerMgr, AdminCustomerPwdHistMgr, AdminCustomerTagMgr, AdminDataIntegrityMgr, AdminEmailMgr, AdminEngineCacheMgr, AdminEventMgr, AdminExecuteMgr, AdminFileMgr, AdminFilterMgr, AdminHtmlMgr, AdminImportMgr, AdminLanguageMgr, AdminLDAPMgr, AdminLoginIntegrationMgr, AdminManufacturerMgr, AdminMessageMgr, AdminMiscItemMgr, AdminMiscPriceMgr, AdminModulesMgr, AdminMultiStoreMgr, AdminOrderIntegrationMgr, AdminOrderMgr, AdminPdfMgr, AdminProductAttrMgr, AdminProductMgr, AdminPromotionMgr, AdminRemoteAccessMgr, AdminReportMgr, AdminReviewMgr, AdminRewardPointMgr, AdminSchedulerMgr, AdminSearchRuleMgr, AdminSecurityMgr, AdminServletMgr, AdminShipmentMgr, AdminSolrMgr, AdminStoreIntegrationMgr, AdminStoreMgr, AdminSuggestionMgr, AdminTagMgr, AdminTaxMgr, AdminValidationMgr, AdminVelocityContextMgr, AdminWishListMgr
```
public class AdminBaseMgr
extends java.lang.Object
```
The base for all Admin Managers

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class AdminBaseMgr.StaticData
Used to store the static data of this manager

Nested Classes
Modifier and Type	Class and Description
`protected class`	`AdminBaseMgr.StaticData` Used to store the static data of this manager

Field Summary

Fields
Modifier and Type	Field and Description
`protected KKAdminIf`	`adminEng` Our Admin Engine
`protected static java.lang.String`	`baseMgrMutex` mutex
`protected static java.util.Map<java.lang.String,AdminBaseMgr.StaticData>`	`baseStaticDataHM` Hash Map that contains the static data
`protected static java.lang.String`	`cDataEnd` CDATA end
`protected static java.lang.String`	`cDataStart` CDATA start
`protected static java.lang.String`	`debugStackTraceExclusions` For excluding lines from debug stack traces - to eliminate unhelpful information
`protected java.lang.String`	`kkAdminPropsFilePath` Properties file path for diagnostic purposes
`protected org.apache.commons.configuration2.Configuration`	`kkConf` Configuration from properties file
`protected static java.lang.String`	`kkInstanceId` The KonaKart Instance - read from the properties file
`private static org.apache.commons.logging.Log`	`log` the log
`protected AdminMgrFactory`	`mgrFactory` Factory for creating managers
`protected static java.lang.String`	`STORE_ID` store id
`protected java.lang.String`	`templateBaseDir` Velocity template base directory under WEB-INF/classes.

Constructor Summary

Constructors
Constructor and Description

AdminBaseMgr()
Constructor

Constructors
Constructor and Description
`AdminBaseMgr()` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static void`	`addInsertAttr(com.konakart.db.KKCriteria 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(com.konakart.db.KKCriteria c, java.lang.String attrName, java.lang.Object value)` A utility to not add null objects
`int`	`addStringRuleConstraint(com.konakart.db.KKCriteria c, java.lang.String value, int rule, org.apache.torque.map.ColumnMap colMap)`
`protected int`	`addStringRuleConstraint(com.konakart.db.KKCriteria c, java.lang.String searchValue, int searchRule, java.lang.String attrId)` Add a String search constraint to the criteria.
`protected void`	`checkAPICallEnabled(java.lang.String apiCall)` Check in the properties that this API call has been enabled otherwise throw an exception
`protected void`	`checkIntInRange(int param, int min, int max, java.lang.String paramName)` Throws an exception if the int parameter is not in the specified range.
`protected void`	`checkIntIsSet(int param, java.lang.String paramType, java.lang.String paramName)` Throws an exception if the int parameter is KKConstants.NOT_SET.
`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.
`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 query, java.util.List<java.lang.Object> whereValues)` Execute query that works for all engine modes
`protected AdminAddressMgrIf`	`getAdminAddressMgr()`
`protected AdminAuditMgrIf`	`getAdminAuditMgr()`
`protected AdminBillingMgrIf`	`getAdminBillingMgr()`
`protected AdminBookableProductMgrIf`	`getAdminBookableProductMgr()`
`protected AdminCategoryMgrIf`	`getAdminCatMgr()`
`protected AdminConfigurationMgrIf`	`getAdminConfigMgr()`
`protected AdminContentMgrIf`	`getAdminContentMgr()`
`protected AdminCurrencyMgrIf`	`getAdminCurrMgr()`
`protected AdminCustomerMgrIf`	`getAdminCustMgr()`
`protected AdminCustomerPwdHistMgrIf`	`getAdminCustPwdHistMgr()`
`protected AdminCustomerTagMgrIf`	`getAdminCustTagMgr()`
`protected AdminEmailMgrIf`	`getAdminEmailMgr()`
`KKAdminIf`	`getAdminEng()`
`protected AdminEngineCacheMgrIf`	`getAdminEngineCacheMgr()`
`protected AdminEventMgrIf`	`getAdminEventMgr()`
`protected AdminExecuteMgrIf`	`getAdminExecuteMgr()`
`AdminFileMgrIf`	`getAdminFileMgr()`
`AdminFilterMgrIf`	`getAdminFilterMgr()`
`AdminHtmlMgrIf`	`getAdminHtmlMgr()`
`protected AdminImportMgrIf`	`getAdminImportMgr(KKAdminIf _adminEng, com.konakart.appif.KKEngIf _eng)`
`protected AdminLanguageMgrIf`	`getAdminLanguageMgr()`
`protected AdminManufacturerMgrIf`	`getAdminManuMgr()`
`AdminMessageMgrIf`	`getAdminMessageMgr()`
`protected AdminMiscItemMgrIf`	`getAdminMiscItemMgr()`
`protected AdminMiscPriceMgrIf`	`getAdminMiscPriceMgr()`
`protected AdminModulesMgrIf`	`getAdminModulesMgr()`
`AdminMultiStoreMgrIf`	`getAdminMultiStoreMgr()`
`protected AdminOrderMgrIf`	`getAdminOrderMgr()`
`protected AdminPdfMgrIf`	`getAdminPdfMgr()`
`protected AdminProdAttrMgrIf`	`getAdminProdAttrMgr()`
`protected AdminProductMgrIf`	`getAdminProdMgr()`
`protected AdminPromotionMgrIf`	`getAdminPromMgr()`
`AdminReviewMgrIf`	`getAdminReviewMgr()`
`protected AdminSearchRuleMgrIf`	`getAdminSearchRuleMgr()`
`protected AdminSecurityMgrIf`	`getAdminSecMgr()`
`protected AdminServletMgrIf`	`getAdminServletMgr()`
`protected AdminShipmentMgrIf`	`getAdminShipmentMgr()`
`AdminSolrMgrIf`	`getAdminSolrMgr()`
`AdminStoreMgrIf`	`getAdminStoreMgr()`
`AdminSuggestionMgrIf`	`getAdminSuggestionMgr()`
`protected AdminTagMgrIf`	`getAdminTagMgr()`
`protected AdminTaxMgrIf`	`getAdminTaxMgr()`
`AdminValidationMgrIf`	`getAdminValidationMgr()`
`AdminVelocityContextMgrIf`	`getAdminVelocityContextMgr()`
`AdminWishListMgrIf`	`getAdminWishListMgr()`
`boolean`	`getBooleanFromString(java.lang.String value, boolean def)` Get a boolean value for the String
`protected static java.lang.String`	`getDebugStackTraceExclusions()`
`protected int`	`getEmailThreadGracefulShutdownTimeout()`
`protected com.konakart.blif.ExportMgrIf`	`getExportMgr()`
`protected com.konakart.blif.ExportMgrIf`	`getExportMgr(com.konakart.appif.KKEngIf storefrontEngine)`
`protected ExportXMLDataIf`	`getExportXMLData()` Finds and returns an implementation of the ExportXMLDataIf on the class path
`int`	`getIntFromString(java.lang.String value, int def)` Get an integer value for the String
`protected java.lang.String`	`getKkAdminPropsFilePath()`
`protected org.apache.commons.configuration2.Configuration`	`getKkConfig()` Get the kkConf the properties file
`protected java.lang.String`	`getKkInstanceId()` Get the instance Id from the properties file
`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 com.konakart.mqif.MqMgrIf`	`getMqMgr()`
`com.konakart.db.KKCriteria`	`getNewCriteria()` Gets a new KKCriteria object and sets the Database name.
`com.konakart.db.KKCriteria`	`getNewCriteria(boolean allStores)` Gets a new KKCriteria object and sets the Database name.
`com.konakart.db.KKCriteria`	`getNewCriteria(boolean allStores, org.apache.torque.sql.Query.Type type)` Gets a new KKCriteria object and sets the Database name.
`com.konakart.db.KKCriteria`	`getNewCriteria(org.apache.torque.sql.Query.Type type)` Gets a new KKCriteria object and sets the Database name.
`protected OtherModuleInterface`	`getOtherModuleByName(java.lang.String moduleName)` Called to instantiate an Admin Other module.
`java.lang.String`	`getPostSearchText()`
`java.lang.String`	`getPreSearchText()`
`protected com.konakart.db.KKCriteria`	`getProductsToCategoresCriteria()` Gets a new KKCriteria object for use with ProductsToCategories.
`protected java.lang.String`	`getPropertyValue(java.lang.String propKey)`
`protected java.lang.String`	`getPropertyValue(java.lang.String propKey, java.lang.String def)` Get the property value as a String if found, otherwise return the default
`protected boolean`	`getPropertyValueAsBool(java.lang.String propKey, boolean def)` Get the property value as a boolean if found, otherwise return the default
`protected int`	`getPropertyValueAsInt(java.lang.String propKey, int def)` Get the property value as an int if found, otherwise return the default
`protected long`	`getPropertyValueAsLong(java.lang.String propKey, long def)` Get the property value as a long if found, otherwise return the default
`protected int`	`getRecordCount(com.konakart.db.KKCriteria c)` This method is mainly used for paging...
`protected int`	`getRecordCount(com.konakart.db.KKCriteria c, java.sql.Connection con)` This method is mainly used for paging...
`protected AdminRewardPointMgrIf`	`getRewardPointMgr()`
`protected int`	`getSingleIntResult(com.konakart.db.KKCriteria c)` This method is used to run a SELECT defined by the Criteria and return the single integer value returned by the query as the result.
`protected java.lang.String`	`getStoreId()` Return the storeId.
`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 under the Template Base Directory
`java.lang.String`	`getTemplateBase(java.lang.String configDir)` Returns the template base directory which is created by concatenating the following: Value of the Directory configuration variable passed in current storeId
`protected Xml_io_If`	`getXml_io()` Finds and returns an implementation of the Xml_io_If on the class path
`protected void`	`init(KKAdminIf eng)` 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`	`isCommunity()` Returns true if we are in Community Mode
`protected boolean`	`isConfigSet(java.lang.String configKey, boolean defaultValue)` Is the specified config key's value is set to TRUE, YES or ON (case insensitive)? If the config key's value isn't found the specified default value is returned.
`protected boolean`	`isEnterprise()` Returns true if we are in Enterprise Mode
`protected boolean`	`isMultiStoreLanguagesShared()` Returns true if we can share languages in multi-store single db mode
`protected boolean`	`isMultiStoreMode()` Is the engine running in one of the MultiStore modes?
`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`	`isMultiStoreShareProducts()` Returns true if we can share products in multi-store single db mode
`protected boolean`	`isMultiStoreSingleDBCSMode()` Is the engine running in MultiStore Single DB Customers Shared mode?
`protected boolean`	`isMultiStoreSingleDBMode()` Is the engine running in one of the MultiStore Single DB modes?
`protected boolean`	`isMultiStoreSingleDBNonCSMode()` Is the engine running in MultiStore Single DB Non-Shared Customers mode?
`protected boolean`	`isUnix()` Is a Windows-like operating system?
`protected boolean`	`isWindows()` Is a Windows-like operating system?
`protected KKAdminException`	`manageException(java.lang.Exception e)` Common code to manage exceptions in the Admin Managers
`protected KKAdminException`	`manageThrowable(java.lang.Throwable e)` Common code to manage Throwable exceptions in the Admin Managers
`void`	`refreshConfigs()` Refresh the configuration of the Admin Base Manager
`java.lang.String`	`removeCData(java.lang.String stringIn)` Returns the string passed in as stringIn without the CData information.
`protected boolean`	`sendMQMessages()` Returns true if we should send MQ messages.
`void`	`setAdminEng(KKAdminIf adminEng)`
`protected static void`	`setDebugStackTraceExclusions(java.lang.String debugStackTraceExclusions)`
`protected void`	`setKkAdminPropsFilePath(java.lang.String kkAdminPropsFilePath)`
`void`	`setupWildCardRules(AdminBaseMgr.StaticData sd)` Some of the managers, but not all, will want to set these Wildcard rules
`void`	`setWildCardAfter(AdminBaseMgr.StaticData sd)` Set the post-search string based on the configuration variable value
`void`	`setWildCardBefore(AdminBaseMgr.StaticData sd)` Set the pre-search string based on the configuration variable value
`protected void`	`shutdownGracefully(java.io.BufferedWriter bw)` Common code to shutdown gracefully for the case where there is a buffered writer for the log.
`protected void`	`shutdownGracefully(java.util.concurrent.ExecutorService executor, java.io.BufferedWriter bw)` Common code to shutdown gracefully for the case where eMails are being send by multiple threads and there is a buffered writer for the log.
`protected java.lang.String`	`timestampStr()`
`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
  - log
```
private static org.apache.commons.logging.Log log
```
    the log
  - baseMgrMutex
```
protected static java.lang.String baseMgrMutex
```
    mutex
  - STORE_ID
```
protected static final java.lang.String STORE_ID
```
    store id
    
    See Also:
    
    Constant Field Values
  - cDataStart
```
protected static final java.lang.String cDataStart
```
    CDATA start
    
    See Also:
    
    Constant Field Values
  - cDataEnd
```
protected static final java.lang.String cDataEnd
```
    CDATA end
    
    See Also:
    
    Constant Field Values
  - adminEng
```
protected KKAdminIf adminEng
```
    Our Admin Engine
  - 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
  - baseStaticDataHM
```
protected static java.util.Map<java.lang.String,AdminBaseMgr.StaticData> baseStaticDataHM
```
    Hash Map that contains the static data
  - mgrFactory
```
protected AdminMgrFactory mgrFactory
```
    Factory for creating managers
  - kkConf
```
protected org.apache.commons.configuration2.Configuration kkConf
```
    Configuration from properties file
  - kkAdminPropsFilePath
```
protected java.lang.String kkAdminPropsFilePath
```
    Properties file path for diagnostic purposes
  - kkInstanceId
```
protected static java.lang.String kkInstanceId
```
    The KonaKart Instance - read from the properties file
  - debugStackTraceExclusions
```
protected static java.lang.String debugStackTraceExclusions
```
    For excluding lines from debug stack traces - to eliminate unhelpful information
- Constructor Detail
  - AdminBaseMgr
```
public AdminBaseMgr()
```
    Constructor
- Method Detail
  - init
```
protected void init(KKAdminIf eng)
             throws java.lang.Exception
```
    Init method called from the super class.
    
    Parameters:
    
    eng - the Admin Engine
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getPropertyValue
```
protected java.lang.String getPropertyValue(java.lang.String propKey)
                                     throws KKAdminException
```
    Parameters:
    
    propKey - the propKey
    
    Returns:
    
    the property value for the specified key in the konakart configuration which was derived from the konakart properties file
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - getPropertyValue
```
protected java.lang.String getPropertyValue(java.lang.String propKey,
                                            java.lang.String def)
                                     throws KKAdminException
```
    Get the property value as a String if found, otherwise return the default
    
    Parameters:
    
    propKey - the property key
    
    def - the default to use if the key isn't found
    
    Returns:
    
    the property value, as a String, for the specified key in the konakart configuration which was derived from the konakartadmin properties file
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - getPropertyValueAsInt
```
protected int getPropertyValueAsInt(java.lang.String propKey,
                                    int def)
                             throws KKAdminException
```
    Get the property value as an int if found, otherwise return the default
    
    Parameters:
    
    propKey - the property key
    
    def - the default to use if the key isn't found
    
    Returns:
    
    the property value, as an int, for the specified key in the konakart configuration which was derived from the konakartadmin properties file
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - getPropertyValueAsLong
```
protected long getPropertyValueAsLong(java.lang.String propKey,
                                      long def)
                               throws KKAdminException
```
    Get the property value as a long if found, otherwise return the default
    
    Parameters:
    
    propKey - the property key
    
    def - the default to use if the key isn't found
    
    Returns:
    
    the property value, as a long, for the specified key in the konakart configuration which was derived from the konakartadmin properties file
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - getPropertyValueAsBool
```
protected boolean getPropertyValueAsBool(java.lang.String propKey,
                                         boolean def)
                                  throws KKAdminException
```
    Get the property value as a boolean if found, otherwise return the default
    
    Parameters:
    
    propKey - the property key
    
    def - the default to use if the key isn't found
    
    Returns:
    
    the property value, as a boolean, for the specified key in the konakart configuration which was derived from the konakartadmin properties file
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - getRecordCount
```
protected int getRecordCount(com.konakart.db.KKCriteria c)
                      throws org.apache.torque.TorqueException,
                             com.workingdogs.village.DataSetException
```
    This method is mainly used for paging... for getting a count of the records defined by the Criteria specified.
    
    Parameters:
    
    c - the Criteria
    
    Returns:
    
    The number of records present in the database matching the given criteria
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - getRecordCount
```
protected int getRecordCount(com.konakart.db.KKCriteria c,
                             java.sql.Connection con)
                      throws org.apache.torque.TorqueException,
                             com.workingdogs.village.DataSetException
```
    This method is mainly used for paging... for getting a count of the records defined by the Criteria specified.
    
    Parameters:
    
    c - the Criteria
    
    con - Connection for transaction
    
    Returns:
    
    The number of records present in the database matching the given criteria
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - getSingleIntResult
```
protected int getSingleIntResult(com.konakart.db.KKCriteria c)
                          throws org.apache.torque.TorqueException,
                                 com.workingdogs.village.DataSetException
```
    This method is used to run a SELECT defined by the Criteria and return the single integer value returned by the query as the result.
    
    Parameters:
    
    c - the Criteria
    
    Returns:
    
    The integer returned by the query
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - getKkConfig
```
protected org.apache.commons.configuration2.Configuration getKkConfig()
                                                               throws KKAdminException
```
    Get the kkConf the properties file
    
    Returns:
    
    A Configuration object that is created by parsing the konakartadmin properties file that is identified on the current engine configuration object.
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - getKkInstanceId
```
protected java.lang.String getKkInstanceId()
                                    throws KKAdminException
```
    Get the instance Id from the properties file
    
    Returns:
    
    the kkInstanceId
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - setupWildCardRules
```
public void setupWildCardRules(AdminBaseMgr.StaticData sd)
```
    Some of the managers, but not all, will want to set these Wildcard rules
    
    Parameters:
    
    sd - StaticData
  - isBusinessOrEnterprise
```
protected boolean isBusinessOrEnterprise()
                                  throws KKAdminException
```
    Returns true if we are in Business or Enterprise Mode
    
    Returns:
    
    true for Business or Enterprise Mode
    
    Throws:
    
    KKAdminException - if the engine config has not yet been defined
  - isEnterprise
```
protected boolean isEnterprise()
                        throws KKAdminException
```
    Returns true if we are in Enterprise Mode
    
    Returns:
    
    true for Enterprise Mode
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine if the engine config has not yet been defined
  - isBusiness
```
protected boolean isBusiness()
                      throws KKAdminException
```
    Returns true if we are in Business Mode
    
    Returns:
    
    true for Business Mode
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine if the engine config has not yet been defined
  - isCommunity
```
protected boolean isCommunity()
                       throws KKAdminException
```
    Returns true if we are in Community Mode
    
    Returns:
    
    true for Community Mode
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine if the engine config has not yet been defined
  - isUnix
```
protected boolean isUnix()
```
    Is a Windows-like operating system?
    
    Returns:
    
    true if this is a Windows-like operating system
  - isWindows
```
protected boolean isWindows()
```
    Is a Windows-like operating system?
    
    Returns:
    
    true if this is a Windows-like operating system
  - getBooleanFromString
```
public boolean getBooleanFromString(java.lang.String value,
                                    boolean def)
```
    Get a boolean value for the String
    
    Parameters:
    
    value - the String value to parse
    
    def - the default result if there's a problem parsing the String
    
    Returns:
    
    the boolean value of the String or the default value if there's a problem
  - getIntFromString
```
public int getIntFromString(java.lang.String value,
                            int def)
```
    Get an integer value for the String
    
    Parameters:
    
    value - the String value to parse
    
    def - the default result if there's a problem parsing the String
    
    Returns:
    
    the integer value of the String or the default value if there's a problem
  - insertKKEvent
```
protected int insertKKEvent(int code,
                            int subCode,
                            int intValue)
                     throws KKAdminException
```
    Parameters:
    
    code - the code
    
    subCode - the subCode
    
    intValue - the intValue
    
    Returns:
    
    Returns the id of the event
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - insertKKEvent
```
protected int insertKKEvent(int code,
                            int subCode,
                            java.lang.String value)
                     throws KKAdminException
```
    Parameters:
    
    code - the code
    
    subCode - the subCode
    
    value - the value
    
    Returns:
    
    Returns the id of the event
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - getAdminAddressMgr
```
protected AdminAddressMgrIf getAdminAddressMgr()
                                        throws java.lang.Exception
```
    Returns:
    
    Returns the AdminAddressMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminAuditMgr
```
protected AdminAuditMgrIf getAdminAuditMgr()
                                    throws java.lang.Exception
```
    Returns:
    
    Returns the AdminAuditMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminBillingMgr
```
protected AdminBillingMgrIf getAdminBillingMgr()
                                        throws java.lang.Exception
```
    Returns:
    
    Returns the AdminBillingMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminBookableProductMgr
```
protected AdminBookableProductMgrIf getAdminBookableProductMgr()
                                                        throws java.lang.Exception
```
    Returns:
    
    Returns the AdminBookableProductMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminCatMgr
```
protected AdminCategoryMgrIf getAdminCatMgr()
                                     throws java.lang.Exception
```
    Returns:
    
    Returns the AdminCategoryMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminCustMgr
```
protected AdminCustomerMgrIf getAdminCustMgr()
                                      throws java.lang.Exception
```
    Returns:
    
    Returns the AdminCustomerMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminConfigMgr
```
protected AdminConfigurationMgrIf getAdminConfigMgr()
                                             throws java.lang.Exception
```
    Returns:
    
    Returns the AdminConfigurationMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminContentMgr
```
protected AdminContentMgrIf getAdminContentMgr()
                                        throws java.lang.Exception
```
    Returns:
    
    Returns the AdminContentMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminCustTagMgr
```
protected AdminCustomerTagMgrIf getAdminCustTagMgr()
                                            throws java.lang.Exception
```
    Returns:
    
    Returns the AdminCustomerTagMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminCurrMgr
```
protected AdminCurrencyMgrIf getAdminCurrMgr()
                                      throws java.lang.Exception
```
    Returns:
    
    Returns the AdminCurrencyMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminCustPwdHistMgr
```
protected AdminCustomerPwdHistMgrIf getAdminCustPwdHistMgr()
                                                    throws java.lang.Exception
```
    Returns:
    
    Returns the AdminCustPwdHistMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminExecuteMgr
```
protected AdminExecuteMgrIf getAdminExecuteMgr()
                                        throws java.lang.Exception
```
    Returns:
    
    Returns the AdminExecuteMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminEmailMgr
```
protected AdminEmailMgrIf getAdminEmailMgr()
                                    throws java.lang.Exception
```
    Returns:
    
    Returns the AdminEmailMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminEngineCacheMgr
```
protected AdminEngineCacheMgrIf getAdminEngineCacheMgr()
                                                throws java.lang.Exception
```
    Returns:
    
    Returns the AdminEngineCacheMgr
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminEventMgr
```
protected AdminEventMgrIf getAdminEventMgr()
                                    throws java.lang.Exception
```
    Returns:
    
    Returns the AdminEventMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminFileMgr
```
public AdminFileMgrIf getAdminFileMgr()
                               throws java.lang.Exception
```
    Returns:
    
    Returns the AdminFileMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminFilterMgr
```
public AdminFilterMgrIf getAdminFilterMgr()
```
    Returns:
    
    Returns an AdminFilterMgr
  - getAdminHtmlMgr
```
public AdminHtmlMgrIf getAdminHtmlMgr()
                               throws java.lang.Exception
```
    Returns:
    
    Returns the AdminHtmlMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminImportMgr
```
protected AdminImportMgrIf getAdminImportMgr(KKAdminIf _adminEng,
                                             com.konakart.appif.KKEngIf _eng)
                                      throws java.lang.Exception
```
    Parameters:
    
    _adminEng - the _adminEng
    
    _eng - the _eng
    
    Returns:
    
    Returns the AdminImportMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminLanguageMgr
```
protected AdminLanguageMgrIf getAdminLanguageMgr()
                                          throws java.lang.Exception
```
    Returns:
    
    Returns the AdminLanguageMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminModulesMgr
```
protected AdminModulesMgrIf getAdminModulesMgr()
                                        throws java.lang.Exception
```
    Returns:
    
    Returns the AdminModulesMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminManuMgr
```
protected AdminManufacturerMgrIf getAdminManuMgr()
                                          throws java.lang.Exception
```
    Returns:
    
    Returns the AdminManufacturerMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminMessageMgr
```
public AdminMessageMgrIf getAdminMessageMgr()
                                     throws java.lang.Exception
```
    Returns:
    
    Returns the AdminMessageMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminMiscPriceMgr
```
protected AdminMiscPriceMgrIf getAdminMiscPriceMgr()
                                            throws java.lang.Exception
```
    Returns:
    
    Returns the AdminMiscPriceMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminMiscItemMgr
```
protected AdminMiscItemMgrIf getAdminMiscItemMgr()
                                          throws java.lang.Exception
```
    Returns:
    
    Returns the AdminMiscItemMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminMultiStoreMgr
```
public AdminMultiStoreMgrIf getAdminMultiStoreMgr()
```
    Returns:
    
    Returns an AdminMultiStoreMgr
  - getAdminOrderMgr
```
protected AdminOrderMgrIf getAdminOrderMgr()
                                    throws java.lang.Exception
```
    Returns:
    
    Returns the AdminOrderMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminPdfMgr
```
protected AdminPdfMgrIf getAdminPdfMgr()
                                throws java.lang.Exception
```
    Returns:
    
    Returns the AdminPdfMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminProdMgr
```
protected AdminProductMgrIf getAdminProdMgr()
                                     throws java.lang.Exception
```
    Returns:
    
    Returns the AdminProductMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminPromMgr
```
protected AdminPromotionMgrIf getAdminPromMgr()
                                       throws java.lang.Exception
```
    Returns:
    
    Returns the AdminPromotionMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminProdAttrMgr
```
protected AdminProdAttrMgrIf getAdminProdAttrMgr()
                                          throws java.lang.Exception
```
    Returns:
    
    Returns the AdminProdAttrMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminReviewMgr
```
public AdminReviewMgrIf getAdminReviewMgr()
                                   throws java.lang.Exception
```
    Returns:
    
    Returns the AdminReviewMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminShipmentMgr
```
protected AdminShipmentMgrIf getAdminShipmentMgr()
                                          throws java.lang.Exception
```
    Returns:
    
    Returns the AdminShipmentMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminSearchRuleMgr
```
protected AdminSearchRuleMgrIf getAdminSearchRuleMgr()
                                              throws java.lang.Exception
```
    Returns:
    
    Returns the AdminSearchRuleMg.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminSecMgr
```
protected AdminSecurityMgrIf getAdminSecMgr()
                                     throws java.lang.Exception
```
    Returns:
    
    Returns the AdminSecurityMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminServletMgr
```
protected AdminServletMgrIf getAdminServletMgr()
                                        throws java.lang.Exception
```
    Returns:
    
    Returns the AdminShipmentMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminSolrMgr
```
public AdminSolrMgrIf getAdminSolrMgr()
                               throws java.lang.Exception
```
    Returns:
    
    Returns the AdminSolrMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminStoreMgr
```
public AdminStoreMgrIf getAdminStoreMgr()
                                 throws java.lang.Exception
```
    Returns:
    
    Returns an AdminStoreMgr
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminSuggestionMgr
```
public AdminSuggestionMgrIf getAdminSuggestionMgr()
                                           throws java.lang.Exception
```
    Returns:
    
    Returns an AdminSuggestionMgr
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminTagMgr
```
protected AdminTagMgrIf getAdminTagMgr()
                                throws java.lang.Exception
```
    Returns:
    
    Returns the AdminTagMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminTaxMgr
```
protected AdminTaxMgrIf getAdminTaxMgr()
                                throws java.lang.Exception
```
    Returns:
    
    Returns the AdminTaxMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminValidationMgr
```
public AdminValidationMgrIf getAdminValidationMgr()
                                           throws java.lang.Exception
```
    Returns:
    
    Returns the AdminValidationMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminVelocityContextMgr
```
public AdminVelocityContextMgrIf getAdminVelocityContextMgr()
                                                     throws java.lang.Exception
```
    Returns:
    
    Returns the AdminVelocityContextMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAdminWishListMgr
```
public AdminWishListMgrIf getAdminWishListMgr()
                                       throws java.lang.Exception
```
    Returns:
    
    Returns the AdminWishListMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getRewardPointMgr
```
protected AdminRewardPointMgrIf getRewardPointMgr()
                                           throws java.lang.Exception
```
    Returns:
    
    Returns the AdminRewardPointMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getExportMgr
```
protected com.konakart.blif.ExportMgrIf getExportMgr(com.konakart.appif.KKEngIf storefrontEngine)
                                              throws java.lang.Exception
```
    Parameters:
    
    storefrontEngine - an instance of a KKEngIf engine
    
    Returns:
    
    Returns the ExportMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getExportMgr
```
protected com.konakart.blif.ExportMgrIf getExportMgr()
                                              throws java.lang.Exception
```
    Returns:
    
    Returns the ExportMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getMqMgr
```
protected com.konakart.mqif.MqMgrIf getMqMgr()
                                      throws java.lang.Exception
```
    Returns:
    
    Returns the MqMgr.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - addInsertAttr
```
protected static void addInsertAttr(com.konakart.db.KKCriteria 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
  - removeCData
```
public java.lang.String removeCData(java.lang.String stringIn)
```
    Returns the string passed in as stringIn without the CData information. i.e. It removes '<![CDATA[' from the start of the string and ']]>' from the end of the string
    
    Parameters:
    
    stringIn - the stringIn
    
    Returns:
    
    stringIn without the CDATA info
  - addInsertAttr
```
protected static void addInsertAttr(com.konakart.db.KKCriteria 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 KKAdminException
```
    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:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - checkIntIsSet
```
protected void checkIntIsSet(int param,
                             java.lang.String paramType,
                             java.lang.String paramName)
                      throws KKAdminException
```
    Throws an exception if the int parameter is KKConstants.NOT_SET.
    
    Parameters:
    
    param - the param
    
    paramType - the paramType
    
    paramName - the paramName
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - checkIntInRange
```
protected void checkIntInRange(int param,
                               int min,
                               int max,
                               java.lang.String paramName)
                        throws KKAdminException
```
    Throws an exception if the int parameter is not in the specified range.
    
    Parameters:
    
    param - the param
    
    min - the min
    
    max - the max
    
    paramName - the paramName
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - setWildCardBefore
```
public void setWildCardBefore(AdminBaseMgr.StaticData sd)
                       throws java.lang.Exception
```
    Set the pre-search string based on the configuration variable value
    
    Parameters:
    
    sd - StaticData
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - isConfigSet
```
protected boolean isConfigSet(java.lang.String configKey,
                              boolean defaultValue)
                       throws org.apache.torque.TorqueException,
                              KKAdminException,
                              com.workingdogs.village.DataSetException,
                              java.lang.Exception
```
    Is the specified config key's value is set to TRUE, YES or ON (case insensitive)? If the config key's value isn't found the specified default value is returned.
    
    Parameters:
    
    configKey - the configuration key
    
    defaultValue - the default value to use if the configuration key isn't found
    
    Returns:
    
    True if the configuration variable is TRUE, ON or YES
    
    Throws:
    
    java.lang.Exception - an unexpected exception
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
  - setWildCardAfter
```
public void setWildCardAfter(AdminBaseMgr.StaticData sd)
                      throws java.lang.Exception
```
    Set the post-search string based on the configuration variable value
    
    Parameters:
    
    sd - StaticData
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getPreSearchText
```
public java.lang.String getPreSearchText()
```
    Returns:
    
    Returns the preSearchText.
  - getPostSearchText
```
public java.lang.String getPostSearchText()
```
    Returns:
    
    Returns the postSearchText.
  - getAdminEng
```
public KKAdminIf getAdminEng()
```
    Returns:
    
    Returns the adminEng.
  - setAdminEng
```
public void setAdminEng(KKAdminIf adminEng)
```
    Parameters:
    
    adminEng - The adminEng to set.
  - addStringRuleConstraint
```
public int addStringRuleConstraint(com.konakart.db.KKCriteria c,
                                   java.lang.String value,
                                   int rule,
                                   org.apache.torque.map.ColumnMap colMap)
```
    Parameters:
    
    c - the c
    
    value - the value
    
    rule - the rule
    
    colMap - the colMap
    
    Returns:
    
    the number of Constraints added
  - addStringRuleConstraint
```
protected int addStringRuleConstraint(com.konakart.db.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)
  - getMode
```
protected int getMode()
               throws KKAdminException
```
    Return the engine mode
    
    Returns:
    
    Return the engine mode
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - getModeString
```
protected java.lang.String getModeString()
```
    Return the engine mode - as a descriptive String for diagnostic purposes only
    
    Returns:
    
    Return the engine mode as a descriptive String
  - isMultiStoreMode
```
protected boolean isMultiStoreMode()
                            throws KKAdminException
```
    Is the engine running in one of the MultiStore modes?
    
    Returns:
    
    Return true if the engine is running in MultiStore mode, otherwise false
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - isMultiStoreSingleDBMode
```
protected boolean isMultiStoreSingleDBMode()
                                    throws KKAdminException
```
    Is the engine running in one of the MultiStore Single DB modes?
    
    Returns:
    
    Return true if the engine is running in MultiStore Single DB mode, otherwise false
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - isMultiStoreSingleDBCSMode
```
protected boolean isMultiStoreSingleDBCSMode()
                                      throws KKAdminException
```
    Is the engine running in MultiStore Single DB Customers Shared mode?
    
    Returns:
    
    Return true if the engine is running in MultiStore Single DB Customers Shared mode, otherwise false
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - isMultiStoreSingleDBNonCSMode
```
protected boolean isMultiStoreSingleDBNonCSMode()
                                         throws KKAdminException
```
    Is the engine running in MultiStore Single DB Non-Shared Customers mode?
    
    Returns:
    
    Return true if the engine is running in MultiStore Single DB Non-Shared Customers mode, otherwise false
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - getStoreId
```
protected java.lang.String getStoreId()
                               throws KKAdminException
```
    Return the storeId. If the AdmnEngineConfig is null, or the storeId on that AdminEngineConfig is null, we return the default store id.
    
    Returns:
    
    Return the storeId
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - getNewCriteria
```
public com.konakart.db.KKCriteria getNewCriteria()
```
    Gets a new KKCriteria object and sets the Database name. If no Engine Configuration is defined a default KKCriteria is returned.
    
    Returns:
    
    Returns a new KKCriteria object for the correct database.
  - getNewCriteria
```
public com.konakart.db.KKCriteria getNewCriteria(org.apache.torque.sql.Query.Type type)
```
    Gets a new KKCriteria object and sets the Database name. If no Engine Configuration is defined a default KKCriteria is returned.
    
    Parameters:
    
    type - the SQL type
    
    Returns:
    
    Returns a new KKCriteria object for the correct database.
  - getNewCriteria
```
public com.konakart.db.KKCriteria getNewCriteria(boolean allStores)
```
    Gets a new KKCriteria object and sets the Database name. If no Engine Configuration is defined a default KKCriteria is returned.
    
    Parameters:
    
    allStores - the allStores
    
    Returns:
    
    Returns a new KKCriteria object for the correct database.
  - getNewCriteria
```
public com.konakart.db.KKCriteria getNewCriteria(boolean allStores,
                                                 org.apache.torque.sql.Query.Type type)
```
    Gets a new KKCriteria object and sets the Database name. If no Engine Configuration is defined a default KKCriteria is returned.
    
    Parameters:
    
    allStores - the allStores
    
    type - the SQL type
    
    Returns:
    
    Returns a new KKCriteria object for the correct database.
  - getProductsToCategoresCriteria
```
protected com.konakart.db.KKCriteria getProductsToCategoresCriteria()
```
    Gets a new KKCriteria object for use with ProductsToCategories.
    
    Returns:
    
    Returns a new KKCriteria object for use with ProductsToCategores queries
  - isMultiStoreShareCustomers
```
protected boolean isMultiStoreShareCustomers()
                                      throws KKAdminException
```
    Returns true if we need to share customers in multi-store single db mode
    
    Returns:
    
    the multiStoreShareCustomers
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - isMultiStoreShareCustomersOrProducts
```
protected boolean isMultiStoreShareCustomersOrProducts()
                                                throws KKAdminException
```
    Returns true if we need to share customers or products in multi-store single db mode
    
    Returns:
    
    the multiStoreShareCustomersOrProducts
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - isMultiStoreShareProducts
```
protected boolean isMultiStoreShareProducts()
                                     throws KKAdminException
```
    Returns true if we can share products in multi-store single db mode
    
    Returns:
    
    true if we're in shared products mode
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - isMultiStoreShareCategories
```
protected boolean isMultiStoreShareCategories()
                                       throws KKAdminException
```
    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:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - isMultiStoreLanguagesShared
```
protected boolean isMultiStoreLanguagesShared()
                                       throws KKAdminException
```
    Returns true if we can share languages in multi-store single db mode
    
    Returns:
    
    true if languages are shared
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - manageException
```
protected KKAdminException manageException(java.lang.Exception e)
```
    Common code to manage exceptions in the Admin Managers
    
    Parameters:
    
    e - the e
    
    Returns:
    
    a new KKAdminException wrapping the specified exception or the original exception if it's a KKAdminException already
  - manageThrowable
```
protected KKAdminException manageThrowable(java.lang.Throwable e)
```
    Common code to manage Throwable exceptions in the Admin Managers
    
    Parameters:
    
    e - the e
    
    Returns:
    
    a new KKAdminException wrapping the specified exception or the original exception if it's a KKAdminException already
  - executeQuery
```
protected java.util.List<com.workingdogs.village.Record> executeQuery(java.lang.String query)
                                                               throws org.apache.torque.TorqueException,
                                                                      KKAdminException
```
    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)
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - 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,
                                                                      KKAdminException
```
    Execute query that works for all engine modes
    
    Parameters:
    
    query - the query
    
    whereValues - values for replacement in the prepared statement
    
    Returns:
    
    the result of the query
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    KKAdminException - an unexpected exception in the KonaKart Admin 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
  - refreshConfigs
```
public void refreshConfigs()
                    throws java.lang.Exception
```
    Refresh the configuration of the Admin Base Manager
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - shutdownGracefully
```
protected void shutdownGracefully(java.util.concurrent.ExecutorService executor,
                                  java.io.BufferedWriter bw)
                           throws java.io.IOException,
                                  java.lang.InterruptedException
```
    Common code to shutdown gracefully for the case where eMails are being send by multiple threads and there is a buffered writer for the log.
    
    Parameters:
    
    executor - the executor
    
    bw - the bw
    
    Throws:
    
    java.io.IOException - an unexpected IOException exception
    
    java.lang.InterruptedException - an unexpected InterruptedException exception
  - shutdownGracefully
```
protected void shutdownGracefully(java.io.BufferedWriter bw)
                           throws java.io.IOException,
                                  java.lang.InterruptedException
```
    Common code to shutdown gracefully for the case where there is a buffered writer for the log.
    
    Parameters:
    
    bw - the bw
    
    Throws:
    
    java.io.IOException - an unexpected IOException exception
    
    java.lang.InterruptedException - an unexpected InterruptedException exception
  - getEmailThreadGracefulShutdownTimeout
```
protected int getEmailThreadGracefulShutdownTimeout()
```
    Returns:
    
    Returns the value of the timeout
  - timestampStr
```
protected java.lang.String timestampStr()
```
    Returns:
    
    a friendly timestamp String using the format "dd-MMM HH:mm:ss"
  - getTemplate
```
public 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,
                                                KKAdminException,
                                                java.lang.Exception
```
    Helper method to search for the velocity templates under the Template Base Directory
    
    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:
    
    org.apache.velocity.exception.ResourceNotFoundException - an unexpected ResourceNotFoundException exception
    
    org.apache.velocity.exception.ParseErrorException - an unexpected ParseErrorException exception
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
    
    java.lang.Exception - an unexpected exception
  - getTemplateBase
```
public java.lang.String getTemplateBase(java.lang.String configDir)
                                 throws org.apache.torque.TorqueException,
                                        com.workingdogs.village.DataSetException,
                                        KKAdminException,
                                        java.lang.Exception
```
    Returns the template base directory which is created by concatenating the following:
    - Value of the Directory configuration variable passed in
    - 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.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
    
    java.lang.Exception - an unexpected exception
  - getXml_io
```
protected Xml_io_If getXml_io()
                       throws KKAdminException
```
    Finds and returns an implementation of the Xml_io_If on the class path
    
    Returns:
    
    an XML IO Manager if found or an exception is thrown if it can't be found.
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine if the Xml_io class cannot be loaded
  - getExportXMLData
```
protected ExportXMLDataIf getExportXMLData()
                                    throws KKAdminException
```
    Finds and returns an implementation of the ExportXMLDataIf on the class path
    
    Returns:
    
    an Export XML Manager if found or an exception is thrown if it can't be found.
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine if the ExportXMLData class cannot be loaded
  - getOtherModuleByName
```
protected OtherModuleInterface getOtherModuleByName(java.lang.String moduleName)
                                             throws KKAdminException
```
    Called to instantiate an Admin Other module.
    
    Parameters:
    
    moduleName - just the classname without the preceding "com.konakartadmin.modules.others." which is added by this method
    
    Returns:
    
    Returns an instantiated Admin Other Module
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine
  - checkAPICallEnabled
```
protected void checkAPICallEnabled(java.lang.String apiCall)
                            throws KKAdminException
```
    Check in the properties that this API call has been enabled otherwise throw an exception
    
    Parameters:
    
    apiCall - the name of the API call.
    
    Throws:
    
    KKAdminException - an unexpected exception in the KonaKart Admin engine the the API call has not been enabled
  - sendMQMessages
```
protected boolean sendMQMessages()
```
    Returns true if we should send MQ messages. Sending can be disabled through the properties file.
    
    Returns:
    
    Returns true if we should send MQ messages
  - getKkAdminPropsFilePath
```
protected java.lang.String getKkAdminPropsFilePath()
```
    Returns:
    
    the kkAdminPropsFilePath
  - setKkAdminPropsFilePath
```
protected void setKkAdminPropsFilePath(java.lang.String kkAdminPropsFilePath)
```
    Parameters:
    
    kkAdminPropsFilePath - the kkAdminPropsFilePath to set
  - 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

Class AdminBaseMgr

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

baseMgrMutex

STORE_ID

cDataStart

cDataEnd

adminEng

templateBaseDir

baseStaticDataHM

mgrFactory

kkConf

kkAdminPropsFilePath

kkInstanceId

debugStackTraceExclusions

Constructor Detail

AdminBaseMgr

Method Detail

init

getPropertyValue

getPropertyValue

getPropertyValueAsInt

getPropertyValueAsLong

getPropertyValueAsBool

getRecordCount

getRecordCount

getSingleIntResult

getKkConfig

getKkInstanceId

setupWildCardRules

isBusinessOrEnterprise

isEnterprise

isBusiness

isCommunity

isUnix

isWindows

getBooleanFromString

getIntFromString

insertKKEvent

insertKKEvent

getAdminAddressMgr

getAdminAuditMgr

getAdminBillingMgr

getAdminBookableProductMgr

getAdminCatMgr

getAdminCustMgr

getAdminConfigMgr

getAdminContentMgr

getAdminCustTagMgr

getAdminCurrMgr

getAdminCustPwdHistMgr

getAdminExecuteMgr

getAdminEmailMgr

getAdminEngineCacheMgr

getAdminEventMgr

getAdminFileMgr

getAdminFilterMgr

getAdminHtmlMgr

getAdminImportMgr

getAdminLanguageMgr

getAdminModulesMgr

getAdminManuMgr

getAdminMessageMgr

getAdminMiscPriceMgr

getAdminMiscItemMgr

getAdminMultiStoreMgr

getAdminOrderMgr

getAdminPdfMgr

getAdminProdMgr

getAdminPromMgr

getAdminProdAttrMgr

getAdminReviewMgr

getAdminShipmentMgr

getAdminSearchRuleMgr

getAdminSecMgr