com.konakart.bl

Class ConfigurationMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.ConfigurationMgr

All Implemented Interfaces:

ConfigurationMgrIf

public class ConfigurationMgr
extends BaseMgr
implements ConfigurationMgrIf

Manages all business logic relevant to the management of configurations within the system

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ConfigurationMgr.StaticData Used to store the static data of this manager

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	configMgrMutex Mutex for the configuration manager
protected static org.apache.commons.logging.Log	log the log
protected static java.util.Map<java.lang.String,ConfigurationMgr.StaticData>	staticDataHM Hash Map that contains the static data

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
ConfigurationMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected boolean	checkIfReturnable(java.lang.String key) Check to see if we can return this configuration parameter.
void	editConfiguration(java.lang.String key, java.lang.String value) Deprecated. From version 6.3.0.0 you should use the Administration APIs (KKAdminIf) instead.
ConfigDataIf[]	getConfigData(java.lang.String key) Returns the ConfigData items with the specified key or all ConfigData items if the key is null.
ConfigDataIf[]	getConfigData(java.lang.String sessionId, java.lang.String key) Returns the ConfigData items with the specified key or all ConfigData items if the key is null.
KKConfiguration	getConfiguration(boolean checkReturnByApi, java.lang.String key) Returns a Configuration object referenced by the key passed in as a parameter.
KKConfiguration	getConfiguration(boolean checkReturnByApi, java.lang.String key, boolean noCache) Returns a Configuration object referenced by the key passed in as a parameter.
KKConfiguration	getConfiguration(java.lang.String key) Returns a Configuration object referenced by the key passed in as a parameter.
KKConfiguration	getConfigurationNoCache(java.lang.String key) Returns a Configuration object referenced by the key passed in as a parameter.
KKConfiguration[]	getConfigurations() Returns an array of Configuration objects containing all configurations that have been defined in the system and that have been defined to be returned via the API.
KKConfiguration[]	getConfigurations(boolean checkReturnByApi) Returns an array of Configuration objects containing all configurations that have been defined in the system.
java.lang.String	getConfigurationValue(boolean checkReturnByApi, java.lang.String key) Returns a Configuration Value for the key passed in as a parameter.
java.lang.String	getConfigurationValue(boolean checkReturnByApi, java.lang.String key, boolean logIfNotFound) Returns a Configuration Value for the key passed in as a parameter.
java.lang.String	getConfigurationValue(java.lang.String key) Returns a Configuration Value for the key passed in as a parameter.
java.math.BigDecimal	getConfigurationValueAsBigDecimal(boolean checkReturnByApi, java.lang.String key) Returns a Configuration Value as a BigDecimal for the key passed in as a parameter.
java.math.BigDecimal	getConfigurationValueAsBigDecimal(boolean checkReturnByApi, java.lang.String key, java.math.BigDecimal def) Returns a Configuration Value as a BigDecimal for the key passed in as a parameter.
java.math.BigDecimal	getConfigurationValueAsBigDecimal(java.lang.String key) Returns a Configuration Value as a BigDecimal for the key passed in as a parameter.
java.math.BigDecimal	getConfigurationValueAsBigDecimal(java.lang.String key, java.math.BigDecimal def) Returns a Configuration Value as a BigDecimal for the key passed in as a parameter.
java.lang.Boolean	getConfigurationValueAsBool(boolean checkReturnByApi, java.lang.String key, java.lang.Boolean def) Returns a Configuration Value as a Boolean for the key passed in as a parameter.
java.lang.Boolean	getConfigurationValueAsBool(java.lang.String key, java.lang.Boolean def) Returns a Configuration Value as a Boolean for the key passed in as a parameter.
int	getConfigurationValueAsInt(boolean checkReturnByApi, java.lang.String key) Returns a Configuration Value as an integer for the key passed in as a parameter.
int	getConfigurationValueAsInt(boolean checkReturnByApi, java.lang.String key, int def) Returns a Configuration Value as an integer for the key passed in as a parameter.
int	getConfigurationValueAsInt(java.lang.String key) Returns a Configuration Value as an integer for the key passed in as a parameter.
int	getConfigurationValueAsInt(java.lang.String key, int def) Returns a Configuration Value as an integer for the key passed in as a parameter.
java.lang.Long	getConfigurationValueAsLong(boolean checkReturnByApi, java.lang.String key) Returns a Configuration Value as a Long for the key passed in as a parameter
java.lang.Long	getConfigurationValueAsLong(boolean checkReturnByApi, java.lang.String key, java.lang.Long def) Returns a Configuration Value as a Long for the key passed in as a parameter
java.lang.Long	getConfigurationValueAsLong(java.lang.String key) Returns a Configuration Value as a Long for the key passed in as a parameter.
java.lang.Long	getConfigurationValueAsLong(java.lang.String key, java.lang.Long def) Returns a Configuration Value as a Long for the key passed in as a parameter.
void	refreshConfigs() Refresh the configuration of the Configuration manager
protected void	setCriteriaWithStandardAttributes(KKCriteria c) Initializes the criteria with the standard attributes

Methods inherited from class com.konakart.bl.BaseMgr

acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

staticDataHM

protected static java.util.Map<java.lang.String,ConfigurationMgr.StaticData> staticDataHM

Hash Map that contains the static data

configMgrMutex

protected static java.lang.String configMgrMutex

Mutex for the configuration manager

Constructor Detail

ConfigurationMgr

public ConfigurationMgr(KKEngIf eng)
                 throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getConfigurations

public KKConfiguration[] getConfigurations()
                                    throws org.apache.torque.TorqueException,
                                           com.workingdogs.village.DataSetException,
                                           com.konakart.app.KKException

Description copied from interface: ConfigurationMgrIf

Returns an array of Configuration objects containing all configurations that have been defined in the system and that have been defined to be returned via the API.

Specified by:

getConfigurations in interface ConfigurationMgrIf

Returns:

An array of Configuration objects.

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)

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

getConfigurations

public KKConfiguration[] getConfigurations(boolean checkReturnByApi)
                                    throws org.apache.torque.TorqueException,
                                           com.workingdogs.village.DataSetException,
                                           com.konakart.app.KKException

Description copied from interface: ConfigurationMgrIf

Returns an array of Configuration objects containing all configurations that have been defined in the system. This returns ALL configuration objects even if they have not been defined to be returned via the API.

Specified by:

getConfigurations in interface ConfigurationMgrIf

Parameters:

checkReturnByApi - if true a check is made on whether each configuration parameter can be returned by the API. Only those configuration parameters allowed to be returned by the API are returned.

if false, no check is performed and all configuration parameters are returned.

Returns:

An array of Configuration objects.

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)

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

getConfiguration

public KKConfiguration getConfiguration(java.lang.String key)
                                 throws org.apache.torque.TorqueException,
                                        com.workingdogs.village.DataSetException,
                                        com.konakart.app.KKException

Returns a Configuration object referenced by the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfiguration in interface ConfigurationMgrIf

Parameters:

key - the key

Returns:

A Configuration object

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)

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

getConfigurationNoCache

public KKConfiguration getConfigurationNoCache(java.lang.String key)
                                        throws org.apache.torque.TorqueException,
                                               com.workingdogs.village.DataSetException,
                                               com.konakart.app.KKException

Returns a Configuration object referenced by the key passed in as a parameter. The object is read from the database and not the internal cache. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationNoCache in interface ConfigurationMgrIf

Parameters:

key - the key

Returns:

A Configuration object

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)

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

getConfigurationValue

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

Returns a Configuration Value for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValue in interface ConfigurationMgrIf

Parameters:

key - the Configuration Key

Returns:

A Configuration Value as a String or null if the key isn't found

Throws:

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

getConfigurationValueAsInt

public int getConfigurationValueAsInt(java.lang.String key)
                               throws com.konakart.app.KKException

Returns a Configuration Value as an integer for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValueAsInt in interface ConfigurationMgrIf

Parameters:

key - the Configuration Key

Returns:

A Configuration Value as an integer or KKConstants.NOT_SET if the key isn't found.

Throws:

com.konakart.app.KKException - if there is a problem converting the configuration value into an integer.

getConfigurationValueAsInt

public int getConfigurationValueAsInt(java.lang.String key,
                                      int def)
                               throws com.konakart.app.KKException

Returns a Configuration Value as an integer for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValueAsInt in interface ConfigurationMgrIf

Parameters:

key - the Configuration Key

def - default value to return if the key isn't found.

Returns:

A Configuration Value as an integer or the default value if the key isn't found.

Throws:

com.konakart.app.KKException - if there is a problem converting the configuration value into an integer.

getConfigurationValueAsBigDecimal

public java.math.BigDecimal getConfigurationValueAsBigDecimal(java.lang.String key)
                                                       throws com.konakart.app.KKException

Returns a Configuration Value as a BigDecimal for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValueAsBigDecimal in interface ConfigurationMgrIf

Parameters:

key - the Configuration Key

Returns:

A Configuration Value as a BigDecimal or null if the key isn't found.

Throws:

com.konakart.app.KKException - if there is a problem converting the configuration value into a BigDecimal.

getConfigurationValueAsBigDecimal

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

Returns a Configuration Value as a BigDecimal for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValueAsBigDecimal in interface ConfigurationMgrIf

Parameters:

key - the Configuration Key

def - default value to use if the key doesn't exist.

Returns:

A Configuration Value as a BigDecimal or the default value if the key isn't found.

Throws:

com.konakart.app.KKException - if there is a problem converting the configuration value into a BigDecimal.

getConfigurationValueAsBool

public java.lang.Boolean getConfigurationValueAsBool(java.lang.String key,
                                                     java.lang.Boolean def)
                                              throws com.konakart.app.KKException

Returns a Configuration Value as a Boolean for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValueAsBool in interface ConfigurationMgrIf

Parameters:

key - the Configuration Key

def - the default value to be returned if there's a problem

Returns:

A Configuration Value as a Boolean or the default value if the key isn't found.

Throws:

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

getConfigData

public ConfigDataIf[] getConfigData(java.lang.String sessionId,
                                    java.lang.String key)
                             throws java.lang.Exception

Description copied from interface: ConfigurationMgrIf

Returns the ConfigData items with the specified key or all ConfigData items if the key is null. The session is checked to ensure it is valid and hasn't expired.

Specified by:

getConfigData in interface ConfigurationMgrIf

Parameters:

sessionId - Session Id of the customer.

key - Only return the ConfigData items with this key

Returns:

Returns an array of ConfigData items with the specified key or all ConfigData items if the key is null ordered by date added

Throws:

java.lang.Exception - an unexpected exception

getConfigData

public ConfigDataIf[] getConfigData(java.lang.String key)
                             throws java.lang.Exception

Description copied from interface: ConfigurationMgrIf

Returns the ConfigData items with the specified key or all ConfigData items if the key is null. No session check is carried out with this version.

Specified by:

getConfigData in interface ConfigurationMgrIf

Parameters:

key - Only return the ConfigData items with this key (if null all ConfigData items are returned)

Returns:

Returns an array of ConfigData items with the specified key or all ConfigData items if the key is null ordered by date added

Throws:

java.lang.Exception - an unexpected exception

getConfiguration

public KKConfiguration getConfiguration(boolean checkReturnByApi,
                                        java.lang.String key)
                                 throws org.apache.torque.TorqueException,
                                        com.workingdogs.village.DataSetException,
                                        com.konakart.app.KKException

Returns a Configuration object referenced by the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfiguration in interface ConfigurationMgrIf

Parameters:

checkReturnByApi - if true a check is made on whether this configuration parameter can be returned by the API. If it can't an Exception is thrown.

key - the key of the configuration parameter

Returns:

A Configuration object

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)

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

getConfiguration

public KKConfiguration getConfiguration(boolean checkReturnByApi,
                                        java.lang.String key,
                                        boolean noCache)
                                 throws org.apache.torque.TorqueException,
                                        com.workingdogs.village.DataSetException,
                                        com.konakart.app.KKException

Returns a Configuration object referenced by the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Parameters:

checkReturnByApi - if true a check is made on whether this configuration parameter can be returned by the API. If it can't an Exception is thrown.

key - the key of the configuration parameter

noCache - when true we don't use the cache

Returns:

A Configuration object

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)

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

getConfigurationValue

public java.lang.String getConfigurationValue(boolean checkReturnByApi,
                                              java.lang.String key)
                                       throws com.konakart.app.KKException

Returns a Configuration Value for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValue in interface ConfigurationMgrIf

Parameters:

checkReturnByApi - if true a check is made on whether this configuration parameter can be returned by the API. If it can't an Exception is thrown.

key - the key of the configuration parameter

Returns:

A Configuration Value as a String or null if the key isn't found

Throws:

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

getConfigurationValue

public java.lang.String getConfigurationValue(boolean checkReturnByApi,
                                              java.lang.String key,
                                              boolean logIfNotFound)
                                       throws com.konakart.app.KKException

Description copied from interface: ConfigurationMgrIf

Returns a Configuration Value for the key passed in as a parameter.

Specified by:

getConfigurationValue in interface ConfigurationMgrIf

Parameters:

checkReturnByApi - if true a check is made on whether this configuration parameter can be returned by the API. If it can't an Exception is thrown.

key - the Configuration Key

logIfNotFound - if true, a logging message is written if the key isn't found

Returns:

A Configuration Value as a String or null if the key isn't found

Throws:

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

getConfigurationValueAsInt

public int getConfigurationValueAsInt(boolean checkReturnByApi,
                                      java.lang.String key)
                               throws com.konakart.app.KKException

Returns a Configuration Value as an integer for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValueAsInt in interface ConfigurationMgrIf

Parameters:

checkReturnByApi - if true a check is made on whether this configuration parameter can be returned by the API. If it can't an Exception is thrown.

key - the key of the configuration parameter

Returns:

A Configuration Value as an integer or KKConstants.NOT_SET if the key isn't found.

Throws:

com.konakart.app.KKException - if there is a problem converting the configuration value into an integer.

getConfigurationValueAsInt

public int getConfigurationValueAsInt(boolean checkReturnByApi,
                                      java.lang.String key,
                                      int def)
                               throws com.konakart.app.KKException

Returns a Configuration Value as an integer for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValueAsInt in interface ConfigurationMgrIf

Parameters:

checkReturnByApi - if true a check is made on whether this configuration parameter can be returned by the API. If it can't an Exception is thrown.

key - the key of the configuration parameter

def - default value to return if the key isn't found.

Returns:

A Configuration Value as an integer or the default value if the key isn't found.

Throws:

com.konakart.app.KKException - if there is a problem converting the configuration value into an integer.

getConfigurationValueAsBigDecimal

public java.math.BigDecimal getConfigurationValueAsBigDecimal(boolean checkReturnByApi,
                                                              java.lang.String key)
                                                       throws com.konakart.app.KKException

Returns a Configuration Value as a BigDecimal for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValueAsBigDecimal in interface ConfigurationMgrIf

Parameters:

checkReturnByApi - if true a check is made on whether this configuration parameter can be returned by the API. If it can't an Exception is thrown.

key - the key of the configuration parameter

Returns:

A Configuration Value as a BigDecimal or null if the key isn't found.

Throws:

com.konakart.app.KKException - if there is a problem converting the configuration value into a BigDecimal.

getConfigurationValueAsBigDecimal

public java.math.BigDecimal getConfigurationValueAsBigDecimal(boolean checkReturnByApi,
                                                              java.lang.String key,
                                                              java.math.BigDecimal def)
                                                       throws com.konakart.app.KKException

Returns a Configuration Value as a BigDecimal for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValueAsBigDecimal in interface ConfigurationMgrIf

Parameters:

checkReturnByApi - if true a check is made on whether this configuration parameter can be returned by the API. If it can't an Exception is thrown.

key - the key of the configuration parameter

def - default value to use if the key doesn't exist.

Returns:

A Configuration Value as a BigDecimal or the default value if the key isn't found.

Throws:

com.konakart.app.KKException - if there is a problem converting the configuration value into a BigDecimal.

getConfigurationValueAsBool

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

Returns a Configuration Value as a Boolean for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValueAsBool in interface ConfigurationMgrIf

Parameters:

checkReturnByApi - if true a check is made on whether this configuration parameter can be returned by the API. If it can't an Exception is thrown.

key - the key of the configuration parameter

def - the default value to be returned if there's a problem

Returns:

A Configuration Value as a Boolean or the default value if the key isn't found.

Throws:

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

getConfigurationValueAsLong

public java.lang.Long getConfigurationValueAsLong(java.lang.String key)
                                           throws com.konakart.app.KKException

Description copied from interface: ConfigurationMgrIf

Returns a Configuration Value as a Long for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValueAsLong in interface ConfigurationMgrIf

Parameters:

key - the Configuration Key

Returns:

A Configuration Value as a Long or KKConstants.NOT_SET_LONG if the key isn't found.

Throws:

com.konakart.app.KKException - if there is a problem converting the configuration value into a Long.

getConfigurationValueAsLong

public java.lang.Long getConfigurationValueAsLong(java.lang.String key,
                                                  java.lang.Long def)
                                           throws com.konakart.app.KKException

Description copied from interface: ConfigurationMgrIf

Returns a Configuration Value as a Long for the key passed in as a parameter. Note that a KKException will be thrown if the configuration key requested has not been marked to be returned by the APIs.

Specified by:

getConfigurationValueAsLong in interface ConfigurationMgrIf

Parameters:

key - the Configuration Key

def - default value to return if the key isn't found.

Returns:

A Configuration Value as a Long or the default value if the key isn't found.

Throws:

com.konakart.app.KKException - if there is a problem converting the configuration value into a Long.

getConfigurationValueAsLong

public java.lang.Long getConfigurationValueAsLong(boolean checkReturnByApi,
                                                  java.lang.String key)
                                           throws com.konakart.app.KKException

Description copied from interface: ConfigurationMgrIf

Returns a Configuration Value as a Long for the key passed in as a parameter

Specified by:

getConfigurationValueAsLong in interface ConfigurationMgrIf

Parameters:

checkReturnByApi - if true a check is made on whether this configuration parameter can be returned by the API. If it can't an Exception is thrown.

key - the Configuration Key

Returns:

A Configuration Value as a Long or KKConstants.NOT_SET_LONG if the key isn't found.

Throws:

com.konakart.app.KKException - if there is a problem converting the configuration value into a Long.

getConfigurationValueAsLong

public java.lang.Long getConfigurationValueAsLong(boolean checkReturnByApi,
                                                  java.lang.String key,
                                                  java.lang.Long def)
                                           throws com.konakart.app.KKException

Description copied from interface: ConfigurationMgrIf

Returns a Configuration Value as a Long for the key passed in as a parameter

Specified by:

getConfigurationValueAsLong in interface ConfigurationMgrIf

Parameters:

checkReturnByApi - if true a check is made on whether this configuration parameter can be returned by the API. If it can't an Exception is thrown.

key - the Configuration Key

def - default value to return if the key isn't found.

Returns:

A Configuration Value as a Long or the default value if the key isn't found.

Throws:

com.konakart.app.KKException - if there is a problem converting the configuration value into a Long.

editConfiguration

@Deprecated
public void editConfiguration(java.lang.String key,
                                          java.lang.String value)
                                   throws com.konakart.app.KKException

Deprecated. From version 6.3.0.0 you should use the Administration APIs (KKAdminIf) instead.

This API has been deprecated and throws a KKException in all cases. Configuration values will no longer be modified using this call.

Previously this call allowed the edit of an existing configuration parameter. It threw an exception if the configuration didn't exist.

Specified by:

editConfiguration in interface ConfigurationMgrIf

Parameters:

key - key whose value will be set

value - value to set

Throws:

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

checkIfReturnable

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

Check to see if we can return this configuration parameter. We look up the "ReturnByApi" attribute for the configuration key. If it's set to 1 (true) we can return the configuration parameter. If set to 0 (false) we cannot and throw a KKException. If there is no configuration parameter for the specified key we log the probably error and return true.

Parameters:

key - the key

Returns:

true if the configuration parameter can be returned by the API

Throws:

com.konakart.app.KKException - if the configuration parameter cannot be returned by the API

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the Configuration manager

Specified by:

refreshConfigs in interface ConfigurationMgrIf

Throws:

java.lang.Exception - an unexpected exception

setCriteriaWithStandardAttributes

protected void setCriteriaWithStandardAttributes(KKCriteria c)

Initializes the criteria with the standard attributes

Parameters:

c - the c