com.sap.tc.webdynpro.services.sal.config.api
Interface IWDConfiguration

All Superinterfaces:

IWDService

public interface IWDConfiguration

extends IWDService

IWDConfiguration specifies the interface to configuration data. Thereby, the configuration consists of name/value pairs. The interface provides methods for typed access to these name/value pairs, as well as methods to define default values which are taken in case a certain configuartion is not set.

See Also:

com.sap.tc.webdynpro.services.sal.core.IConfigurationFactory

Method Summary

java.lang.String[]	getAllKeys() Get all configuration entry keys.
boolean[]	getBooleanEntries(java.lang.String key) Gets configuration entry of type multiple booleans by key.
boolean	getBooleanEntry(java.lang.String key) Gets configuration entry of type boolean by key.
boolean	getBooleanEntry(java.lang.String key, boolean defaultValue) Gets configuration entry of type boolean by key.
java.util.Date[]	getDateEntries(java.lang.String key) Gets configuration entry of type multiple dates by key.
java.util.Date	getDateEntry(java.lang.String key) Gets configuration entry of type date by key.
java.util.Date	getDateEntry(java.lang.String key, java.util.Date defaultValue) Gets configuration entry of type date by key.
int[]	getIntEntries(java.lang.String key) Gets configuration entry of type multiple ints by key.
int	getIntEntry(java.lang.String key) Gets configuration entry of type int by key.
int	getIntEntry(java.lang.String key, int defaultValue) Gets configuration entry of type int by key.
long[]	getLongEntries(java.lang.String key) Gets configuration entry of type multiple longs by key.
long	getLongEntry(java.lang.String key) Gets configuration entry of type long by key.
long	getLongEntry(java.lang.String key, long defaultValue) Gets configuration entry of type long by key.
java.lang.String[]	getStringEntries(java.lang.String key) Gets configuration entry of type multiple strings by key.
java.lang.String	getStringEntry(java.lang.String key) Gets configuration entry of type string by key.
java.lang.String	getStringEntry(java.lang.String key, java.lang.String defaultValue) Gets configuration entry of type string by key.

Methods inherited from interface com.sap.tc.webdynpro.services.sal.api.IWDService

getDescription, getServiceName, getVersion

Method Detail

getStringEntry

public java.lang.String getStringEntry(java.lang.String key)
                                throws WDInvalidConfigParameterException

Gets configuration entry of type string by key.

Parameters:

key - key of configuration entry

Returns:

value of configuration entry

Throws:

WDInvalidConfigParameterException - if the specified parameter cannot be found in the configuration

getStringEntry

public java.lang.String getStringEntry(java.lang.String key,
                                       java.lang.String defaultValue)

Gets configuration entry of type string by key.

Parameters:

key - key of configuration entry

defaultValue - default value for configuration entry

Returns:

value of configuration entry

getStringEntries

public java.lang.String[] getStringEntries(java.lang.String key)
                                    throws WDInvalidConfigParameterException

Gets configuration entry of type multiple strings by key.

Parameters:

key - key of configuration entry

Returns:

values of configuration entry

Throws:

WDInvalidConfigParameterException - if the specified parameter cannot be found in the configuration

getDateEntry

public java.util.Date getDateEntry(java.lang.String key)
                            throws WDInvalidConfigParameterException

Gets configuration entry of type date by key.

Parameters:

key - key of configuration entry

Returns:

value of configuration entry

Throws:

WDInvalidConfigParameterException - if the specified parameter cannot be found in the configuration

getDateEntry

public java.util.Date getDateEntry(java.lang.String key,
                                   java.util.Date defaultValue)

Gets configuration entry of type date by key.

Parameters:

key - key of configuration entry

defaultValue - default value for configuration entry

Returns:

value of configuration entry

getDateEntries

public java.util.Date[] getDateEntries(java.lang.String key)
                                throws WDInvalidConfigParameterException

Gets configuration entry of type multiple dates by key.

Parameters:

key - key of configuration entry

Returns:

values of configuration entry

Throws:

WDInvalidConfigParameterException - if the specified parameter cannot be found in the configuration

getIntEntry

public int getIntEntry(java.lang.String key)
                throws WDInvalidConfigParameterException

Gets configuration entry of type int by key.

Parameters:

key - key of configuration entry

Returns:

value of configuration entry

Throws:

WDInvalidConfigParameterException - if the specified parameter cannot be found in the configuration

getIntEntry

public int getIntEntry(java.lang.String key,
                       int defaultValue)

Gets configuration entry of type int by key.

Parameters:

key - key of configuration entry

defaultValue - default value for configuration entry

Returns:

value of configuration entry

getIntEntries

public int[] getIntEntries(java.lang.String key)
                    throws WDInvalidConfigParameterException

Gets configuration entry of type multiple ints by key.

Parameters:

key - key of configuration entry

Returns:

values of configuration entry

Throws:

WDInvalidConfigParameterException - if the specified parameter cannot be found in the configuration

getLongEntry

public long getLongEntry(java.lang.String key)
                  throws WDInvalidConfigParameterException

Gets configuration entry of type long by key.

Parameters:

key - key of configuration entry

Returns:

value of configuration entry

Throws:

WDInvalidConfigParameterException - if the specified parameter cannot be found in the configuration

getLongEntry

public long getLongEntry(java.lang.String key,
                         long defaultValue)

Gets configuration entry of type long by key.

Parameters:

key - key of configuration entry

defaultValue - default value for configuration entry

Returns:

value of configuration entry

getLongEntries

public long[] getLongEntries(java.lang.String key)
                      throws WDInvalidConfigParameterException

Gets configuration entry of type multiple longs by key.

Parameters:

key - key of configuration entry

Returns:

values of configuration entry

Throws:

ConfigException - Exception raised in failure situation

WDInvalidConfigParameterException - if the specified parameter cannot be found in the configuration

getBooleanEntry

public boolean getBooleanEntry(java.lang.String key)
                        throws WDInvalidConfigParameterException

Gets configuration entry of type boolean by key.

Parameters:

key - key of configuration entry

Returns:

value of configuration entry

Throws:

WDInvalidConfigParameterException - if the specified parameter cannot be found in the configuration

getBooleanEntry

public boolean getBooleanEntry(java.lang.String key,
                               boolean defaultValue)

Gets configuration entry of type boolean by key.

Parameters:

key - key of configuration entry

defaultValue - default value for configuration entry

Returns:

value of configuration entry

getBooleanEntries

public boolean[] getBooleanEntries(java.lang.String key)
                            throws WDInvalidConfigParameterException

Gets configuration entry of type multiple booleans by key.

Parameters:

key - key of configuration entry

Returns:

values of configuration entry

Throws:

WDInvalidConfigParameterException - if the specified parameter cannot be found in the configuration

getAllKeys

public java.lang.String[] getAllKeys()

Get all configuration entry keys.

Returns:

all configuration entry keys