org.jcoderz.commons.config
Interface ConfigurationServiceCommonInterface

All Known Subinterfaces:
ConfigurationService, ConfigurationServiceAdmin, ConfigurationServiceAdminInterface, ConfigurationServiceInterface
All Known Implementing Classes:
ConfigurationServiceAdminBean, ConfigurationServiceAdminImpl, ConfigurationServiceAdminSession, ConfigurationServiceBean, ConfigurationServiceCommonImpl, ConfigurationServiceImpl, ConfigurationServiceSession

public interface ConfigurationServiceCommonInterface

Common ConfigurationService's business interface with getter method to get configuration parameters. On this level only primitve types String, int, long and boolean are used. The wellformed and complex typed interfaces for the specific services are using this more simple interface.


Method Summary
 boolean getBoolean(ConfigurationKey key)
          Returns the boolean value that is associated with the given key.
 int getInt(ConfigurationKey key)
          Returns the int value that is associated with the given key.
 long getLong(ConfigurationKey key)
          Returns the long value that is associated with the given key.
 String getString(ConfigurationKey key)
          Returns the String value that is associated with the given key.
 

Method Detail

getBoolean

boolean getBoolean(ConfigurationKey key)
                   throws RemoteException,
                          ConfigurationValueNotFoundException,
                          ConfigurationTypeConversionFailedException,
                          ArgumentMalformedException
Returns the boolean value that is associated with the given key.

Parameters:
key - ConfigurationKey that is the key for a stored configuration value.
Returns:
the boolean value that is associated with the given key.
Throws:
RemoteException - if a remote call fails.
ConfigurationValueNotFoundException - in case there is no match to key.
ConfigurationTypeConversionFailedException - in case the found value could not be converted to boolean type.
ArgumentMalformedException - Is thrown to indicate the illegal use of a null object as input parameter.

getInt

int getInt(ConfigurationKey key)
           throws RemoteException,
                  ConfigurationValueNotFoundException,
                  ConfigurationTypeConversionFailedException,
                  ArgumentMalformedException,
                  NumberFormatException
Returns the int value that is associated with the given key.

Parameters:
key - ConfigurationKey that is the key for a stored configuration value.
Returns:
the int value that is associated with the given key.
Throws:
RemoteException - if a remote call fails.
ConfigurationValueNotFoundException - in case there is no match to the key.
ConfigurationTypeConversionFailedException - in case the found value could not be converted to int type.
ArgumentMalformedException - Is thrown to indicate the illegal use of a null object as input parameter.
NumberFormatException - in case the stored value cannot be converted into an int

getLong

long getLong(ConfigurationKey key)
             throws RemoteException,
                    ConfigurationValueNotFoundException,
                    ConfigurationTypeConversionFailedException,
                    ArgumentMalformedException
Returns the long value that is associated with the given key.

Parameters:
key - ConfigurationKey that is the key for a stored configuration value.
Returns:
the long value that is associated with the given key.
Throws:
RemoteException - if a remote call fails.
ConfigurationValueNotFoundException - in case there is no match to the key.
ConfigurationTypeConversionFailedException - in case the found value could not be converted to long type.
ArgumentMalformedException - Is thrown to indicate the illegal use of a null object as input parameter.

getString

String getString(ConfigurationKey key)
                 throws RemoteException,
                        ConfigurationValueNotFoundException,
                        ArgumentMalformedException
Returns the String value that is associated with the given key.

Parameters:
key - ConfigurationKey that is the key for a stored configuration value.
Returns:
the String value that is associated with the given key.
Throws:
RemoteException - if a remote call fails.
ConfigurationValueNotFoundException - in case there is no match to the key.
ArgumentMalformedException - Is thrown to indicate the illegal use of a null object as input parameter.


Copyright 2007 The jCoderZ Project.