com.konakartadmin.blif

Interface AdminConfigurationMgrIf

All Known Implementing Classes:

AdminConfigurationMgr

public interface AdminConfigurationMgrIf

AdminConfigurationMgrIf

Method Summary

Modifier and Type	Method and Description
AdminConfigurationGroup[]	getAllConfigurationGroups() Returns an array of all the Configuration Group objects
KKConfiguration[]	getAllConfigurations() Returns an array of all the Configuration objects
AdminConfigData[]	getConfigData(java.lang.String key) Returns the AdminConfigData items with the specified key or all AdminConfigData items if the key is null.
KKConfiguration	getConfiguration(java.lang.String key) Returns a Configuration object referenced by the specified key.
KKConfiguration	getConfigurationFromDb(java.lang.String key) Returns a Configuration object from the database referenced by the specified key
AdminConfigurationGroup[]	getConfigurationGroupsByTitle(java.lang.String title) Returns an array of AdminConfigurationGroup objects with the specified title
java.lang.String[]	getConfigurationInfo(java.lang.String[] validationKeys) Get the configuration values for the given keys
int	getConfigurationIntValue(java.lang.String key) Returns a Configuration Value for the specified key as an integer
int	getConfigurationIntValueOrDefault(java.lang.String key, int defaultVal) Returns a Configuration Value for the specified key as an integer - or a default value
KKConfiguration[]	getConfigurationsByGroup(int configGroup) Returns an array of Configuration objects for the specified configuration group id
java.lang.String	getConfigurationValue(java.lang.String key) Returns a Configuration Value for the specified key
java.lang.String	getConfigurationValue(java.lang.String key, java.lang.String def) Returns a Configuration Value for the specified key or the default if the configuration key can't be found
boolean	getConfigurationValueAsBool(java.lang.String key, boolean defaultVal) Returns a Configuration Value for the specified key as a boolean - or the specified default value
java.lang.String	getPropertyValue(java.lang.String propKey)
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
boolean	getPropertyValueAsBool(java.lang.String propKey, boolean def) Get the property value as a boolean if found, otherwise return the default
int	getPropertyValueAsInt(java.lang.String propKey, int def) Get the property value as an int if found, otherwise return the default
long	getPropertyValueAsLong(java.lang.String propKey, long def) Get the property value as a long if found, otherwise return the default
long	getRefreshCacheRequest()
int[]	insertConfigData(AdminConfigData[] configs) Insert the AdminConfigData items.
void	insertConfigs(KKConfiguration[] config) Insert one or more new configuration parameters
int	insertConfiguration(KKConfiguration config) Insert a configuration object
int	insertConfigurationGroup(AdminConfigurationGroup configGroup) Insert a configuration group
void	refreshConfigs() Refresh the ConfigurationMgr Cache
void	removeConfigData(int id) Remove the AdminConfigData item from the Database.
void	removeConfigs(java.lang.String[] configKeys) Remove one or more configuration parameters
void	removeConfigsByIds(int[] configIds) Remove one or more configuration parameters
void	saveConfigs(KKConfiguration[] configs, KKConfiguration[] origConfigs) Saves an array of KKConfiguration objects to the database.
boolean	setConfigurationValue(java.lang.String key, java.lang.String value) Sets a Configuration Value for the specified key
void	setRefreshCacheRequest(long refreshCacheRequest)
void	updateConfigCaches() Updates any caches we have made of the configuration variables
void	updateConfigData(AdminConfigData[] configs) Update the AdminConfigData items.
void	updateConfiguration(KKConfiguration newConf) Updates a KKConfiguration object
void	updateConfigurationGroup(AdminConfigurationGroup newConf) Updates an AdminConfigurationGroup object

Method Detail

getConfigurationsByGroup

KKConfiguration[] getConfigurationsByGroup(int configGroup)
                                    throws org.apache.torque.TorqueException,
                                           com.workingdogs.village.DataSetException

Returns an array of Configuration objects for the specified configuration group id

Parameters:

configGroup - the Configuration GroupId

Returns:

An array of Configuration objects in the specified Config Group

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)

getAllConfigurations

KKConfiguration[] getAllConfigurations()
                                throws org.apache.torque.TorqueException,
                                       com.workingdogs.village.DataSetException

Returns an array of all the Configuration objects

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)

getAllConfigurationGroups

AdminConfigurationGroup[] getAllConfigurationGroups()
                                             throws org.apache.torque.TorqueException,
                                                    com.workingdogs.village.DataSetException

Returns an array of all the Configuration Group objects

Returns:

An array of Configuration Group 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)

getConfigurationInfo

java.lang.String[] getConfigurationInfo(java.lang.String[] validationKeys)
                                 throws org.apache.torque.TorqueException,
                                        com.workingdogs.village.DataSetException,
                                        KKAdminException

Get the configuration values for the given keys

Parameters:

validationKeys - an arrray of configuration keys

Returns:

Returns an array of Configuration key values - typically used for validation on the UI

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

getConfiguration

KKConfiguration getConfiguration(java.lang.String key)
                          throws org.apache.torque.TorqueException,
                                 com.workingdogs.village.DataSetException,
                                 KKAdminException

Returns a Configuration object referenced by the specified key. First the cache is searched for the specified key. If not found it looks up the configuration object in the database, then, if found, stores it in the cache.

Parameters:

key - the key

Returns:

The KKConfiguration object if the key is found, otherwise it returns null

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

getConfigurationFromDb

KKConfiguration getConfigurationFromDb(java.lang.String key)
                                throws org.apache.torque.TorqueException,
                                       com.workingdogs.village.DataSetException,
                                       KKAdminException

Returns a Configuration object from the database referenced by the specified key

Parameters:

key - thConfiguration Key

Returns:

The KKConfiguration object if the key is found, otherwise it returns null

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

getConfigurationValue

java.lang.String getConfigurationValue(java.lang.String key)
                                throws org.apache.torque.TorqueException,
                                       com.workingdogs.village.DataSetException,
                                       KKAdminException

Returns a Configuration Value for the specified key

Parameters:

key - the Configuration key

Returns:

The String value of the specified configuration key's value or null if the key is not found.

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

getConfigurationValue

java.lang.String getConfigurationValue(java.lang.String key,
                                       java.lang.String def)
                                throws org.apache.torque.TorqueException,
                                       com.workingdogs.village.DataSetException,
                                       KKAdminException

Returns a Configuration Value for the specified key or the default if the configuration key can't be found

Parameters:

key - the Configuration key

def - the default to use if the configuration key can't be found

Returns:

The String value of the specified configuration key's value or the default if the configuration key can't be found.

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

getConfigurationIntValue

int getConfigurationIntValue(java.lang.String key)
                      throws org.apache.torque.TorqueException,
                             com.workingdogs.village.DataSetException,
                             KKAdminException

Returns a Configuration Value for the specified key as an integer

Parameters:

key - the configuration key

Returns:

the value of the key as an integer - or KonakartAdminConstants.NOT_SET if the key isn't found

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

getConfigurationIntValueOrDefault

int getConfigurationIntValueOrDefault(java.lang.String key,
                                      int defaultVal)
                               throws org.apache.torque.TorqueException,
                                      com.workingdogs.village.DataSetException,
                                      KKAdminException

Returns a Configuration Value for the specified key as an integer - or a default value

Parameters:

key - the configuration key

defaultVal - the default value to be returned if the key isn't found

Returns:

the value of the key as an integer - or the specified default if the key isn't found

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

getConfigurationValueAsBool

boolean getConfigurationValueAsBool(java.lang.String key,
                                    boolean defaultVal)
                             throws org.apache.torque.TorqueException,
                                    com.workingdogs.village.DataSetException,
                                    KKAdminException

Returns a Configuration Value for the specified key as a boolean - or the specified default value

Parameters:

key - the configuration key

defaultVal - the default value to be returned if the key isn't found

Returns:

the value of the key as a boolean - or the specified default if the key isn't found

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

setConfigurationValue

boolean setConfigurationValue(java.lang.String key,
                              java.lang.String value)
                       throws org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException,
                              KKAdminException

Sets a Configuration Value for the specified key

Parameters:

key - key whose value will be set

value - value to set

Returns:

returns true if the value is set correctly, false if the key wasn't found

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

saveConfigs

void saveConfigs(KKConfiguration[] configs,
                 KKConfiguration[] origConfigs)
          throws java.lang.Exception

Saves an array of KKConfiguration objects to the database.

Parameters:

configs - Configuration array to save. For optimum performance, any records to insert should be placed at the end of the array and marked with the status KonakartAdminConstants.STATUS_INSERTED. Any records to be deleted should be marked with the KonakartAdminConstants.STATUS_DELETED status.

origConfigs - Original Configuration array to compare against

Throws:

java.lang.Exception - an unexpected exception

insertConfigs

void insertConfigs(KKConfiguration[] config)
            throws org.apache.torque.TorqueException

Insert one or more new configuration parameters

Parameters:

config - an array of KKConfiguration objects to insert

Throws:

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

removeConfigs

void removeConfigs(java.lang.String[] configKeys)
            throws org.apache.torque.TorqueException,
                   java.lang.Exception

Remove one or more configuration parameters

Parameters:

configKeys - an array of configuration key Strings to remove

Throws:

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

java.lang.Exception - an unexpected exception

removeConfigsByIds

void removeConfigsByIds(int[] configIds)
                 throws org.apache.torque.TorqueException,
                        java.lang.Exception

Remove one or more configuration parameters

Parameters:

configIds - an array of configuration Id ints to remove

Throws:

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

java.lang.Exception - an unexpected exception

updateConfigCaches

void updateConfigCaches()
                 throws java.lang.Exception

Updates any caches we have made of the configuration variables

Throws:

java.lang.Exception - an unexpected exception

insertConfigurationGroup

int insertConfigurationGroup(AdminConfigurationGroup configGroup)
                      throws org.apache.torque.TorqueException,
                             KKAdminException

Insert a configuration group

Parameters:

configGroup - an AdminConfigurationGroup object to insert

Returns:

Returns the primary key of the configuration group that was inserted

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertConfiguration

int insertConfiguration(KKConfiguration config)
                 throws org.apache.torque.TorqueException,
                        KKAdminException

Insert a configuration object

Parameters:

config - a KKConfiguration object to insert

Returns:

Returns the primary key of the configuration object that was inserted

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

updateConfiguration

void updateConfiguration(KKConfiguration newConf)
                  throws org.apache.torque.TorqueException,
                         com.workingdogs.village.DataSetException,
                         KKAdminException

Updates a KKConfiguration object

Parameters:

newConf - the KKConfiguration to update

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

updateConfigurationGroup

void updateConfigurationGroup(AdminConfigurationGroup newConf)
                       throws org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException,
                              KKAdminException

Updates an AdminConfigurationGroup object

Parameters:

newConf - the AdminConfigurationGroup to update

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

getConfigurationGroupsByTitle

AdminConfigurationGroup[] getConfigurationGroupsByTitle(java.lang.String title)
                                                 throws org.apache.torque.TorqueException,
                                                        com.workingdogs.village.DataSetException,
                                                        KKAdminException

Returns an array of AdminConfigurationGroup objects with the specified title

Parameters:

title - the title

Returns:

An array of AdminConfigurationGroup 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)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getConfigData

AdminConfigData[] getConfigData(java.lang.String key)
                         throws org.apache.torque.TorqueException,
                                com.workingdogs.village.DataSetException,
                                KKAdminException

Returns the AdminConfigData items with the specified key or all AdminConfigData items if the key is null.

Parameters:

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

Returns:

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

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

updateConfigData

void updateConfigData(AdminConfigData[] configs)
               throws KKAdminException,
                      org.apache.torque.TorqueException

Update the AdminConfigData items.

Parameters:

configs - The AdminConfigData items to update

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

insertConfigData

int[] insertConfigData(AdminConfigData[] configs)
                throws KKAdminException,
                       org.apache.torque.TorqueException

Insert the AdminConfigData items.

Parameters:

configs - The AdminConfigData items to insert

Returns:

Return an array containing the Ids of the inserted AdminConfigData objects

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

removeConfigData

void removeConfigData(int id)
               throws KKAdminException,
                      org.apache.torque.TorqueException

Remove the AdminConfigData item from the Database.

Parameters:

id - The id of the AdminConfigData items to remove

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getPropertyValue

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

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

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

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

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

refreshConfigs

void refreshConfigs()
             throws KKAdminException

Refresh the ConfigurationMgr Cache

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getRefreshCacheRequest

long getRefreshCacheRequest()

Returns:

the refreshCacheRequest

setRefreshCacheRequest

void setRefreshCacheRequest(long refreshCacheRequest)

Parameters:

refreshCacheRequest - the refreshCacheRequest to set