com.konakart.blif

Interface ConfigurationMgrIf

All Known Implementing Classes:

ConfigurationMgr

public interface ConfigurationMgrIf

ConfigurationMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

Modifier and Type	Method and Description
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(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

Method Detail

getConfigurations

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

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.

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

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

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.

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

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.

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

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.

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

getConfiguration

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.

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

getConfigurationValue

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.

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

getConfigurationValue

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.

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 String or null if the key isn't found

Throws:

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

getConfigurationValue

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

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

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

getConfigurationValueAsLong

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

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.

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

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

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

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

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

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.

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

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

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

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.

getConfigurationValueAsInt

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

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

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.

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

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.

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.

getConfigurationValueAsInt

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

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

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.

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

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

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

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.

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.

getConfigurationValueAsBigDecimal

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

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

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.

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

getConfigurationValueAsBool

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

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

editConfiguration

@Deprecated
void editConfiguration(java.lang.String key,
                                   java.lang.String value)
                            throws org.apache.torque.TorqueException,
                                   com.workingdogs.village.DataSetException,
                                   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.

Parameters:

key - key whose value will be set

value - value to set

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

getConfigData

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

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.

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

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

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.

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

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refresh the configuration of the Configuration manager

Throws:

java.lang.Exception - an unexpected exception