IConfiguration (VDocSDKInterfaces 15.5.2-SNAPSHOT API)

All Superinterfaces:

IElement, Serializable
```
public interface IConfiguration
extends IElement
```
The IConfiguration interface represents a configuration of a ICatalog object.

Since:

1.0, 15/04/2008

Author:

vlygeros

See Also:

ICatalog

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`IConfiguration.CatalogKeys` Catalog scope keys
`static interface`	`IConfiguration.CommonKeys` The common keys
`static interface`	`IConfiguration.ProjectKeys` Project scope keys
`static interface`	`IConfiguration.ServerKeys` Server keys
`static interface`	`IConfiguration.SupportedKeys` Deprecated. Use ServerKeys instead

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`BigDecimal`	`getBigDecimalProperty(String key)` Retrieves a standard property by passing its key.
`BigDecimal`	`getBigDecimalProperty(String key, BigDecimal defaultValue)` Retrieves a standard property by passing its key.
`BigDecimal`	`getBigDecimalUserProperty(String key)` Retrieves a specific property by passing its key.
`BigDecimal`	`getBigDecimalUserProperty(String key, BigDecimal defaultValue)` Retrieves a specific property by passing its key.
`boolean`	`getBooleanProperty(String key)` Retrieves a standard property by passing its key.
`boolean`	`getBooleanProperty(String key, boolean defaultValue)` Retrieves a standard property by passing its key.
`boolean`	`getBooleanUserProperty(String key)` Retrieves a specific property by passing its key.
`boolean`	`getBooleanUserProperty(String key, boolean defaultValue)` Retrieves a specific property by passing its key.
`double`	`getDoubleProperty(String key)` Retrieves a standard property by passing its key.
`double`	`getDoubleProperty(String key, double defaultValue)` Retrieves a standard property by passing its key.
`double`	`getDoubleUserProperty(String key)` Retrieves a specific property by passing its key.
`double`	`getDoubleUserProperty(String key, double defaultValue)` Retrieves a specific property by passing its key.
`float`	`getFloatProperty(String key)` Retrieves a standard property by passing its key.
`float`	`getFloatProperty(String key, float defaultValue)` Retrieves a standard property by passing its key.
`float`	`getFloatUserProperty(String key)` Retrieves a specific property by passing its key.
`float`	`getFloatUserProperty(String key, float defaultValue)` Retrieves a specific property by passing its key.
`int`	`getIntegerProperty(String key)` Retrieves a standard property by passing its key.
`int`	`getIntegerProperty(String key, int defaultValue)` Retrieves a standard property by passing its key.
`int`	`getIntegerUserProperty(String key)` Retrieves a specific property by passing its key.
`int`	`getIntegerUserProperty(String key, int defaultValue)` Retrieves a specific property by passing its key.
`long`	`getLongProperty(String key)` Retrieves a standard property by passing its key.
`long`	`getLongProperty(String key, long defaultValue)` Retrieves a standard property by passing its key.
`long`	`getLongUserProperty(String key)` Retrieves a specific property by passing its key.
`long`	`getLongUserProperty(String key, long defaultValue)` Retrieves a specific property by passing its key.
`Object`	`getObjectUserProperty(String key)` Retrieves a specific property by passing its key.
`Object`	`getObjectUserProperty(String key, Object defaultValue)` Retrieves a specific property by passing its key.
`Properties`	`getProperties()` Retrieves all standard properties
`String`	`getProperty(String key)` Deprecated. use getStringProperty() method instead.
`String[]`	`getStringArrayProperty(String key)` Retrieves standard property values by passing its key.
`String`	`getStringProperty(String key)` Retrieves a standard property by passing its key.
`String`	`getStringProperty(String key, String defaultValue)` Retrieves a standard property by passing its key.
`String`	`getStringUserProperty(String key)` Retrieves a specific property by passing its key.
`String`	`getStringUserProperty(String key, String defaultValue)` Retrieves a specific property by passing its key.
`Properties`	`getUserProperties()` Retreves all specific properties
`String`	`getUserProperty(String key)` Deprecated. use getStringUserProperty() method instead.

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement
getId, getModule, getNativeObject, getPath, save

- Method Detail
  - getProperty
```
@Deprecated
String getProperty(String key)
```
    Deprecated. use getStringProperty() method instead.
    
    Retrieves a standard property by passing its key The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A string value
  - getBooleanProperty
```
boolean getBooleanProperty(String key)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A boolean value
  - getBooleanProperty
```
boolean getBooleanProperty(String key,
                           boolean defaultValue)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A bool value
  - getDoubleProperty
```
double getDoubleProperty(String key)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A double value
  - getDoubleProperty
```
double getDoubleProperty(String key,
                         double defaultValue)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A double value
  - getBigDecimalProperty
```
BigDecimal getBigDecimalProperty(String key)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A BigDecimal value
  - getBigDecimalProperty
```
BigDecimal getBigDecimalProperty(String key,
                                 BigDecimal defaultValue)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A BigDecimal value
  - getFloatProperty
```
float getFloatProperty(String key)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A float value
  - getFloatProperty
```
float getFloatProperty(String key,
                       float defaultValue)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A float value
  - getIntegerProperty
```
int getIntegerProperty(String key)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A int value
  - getIntegerProperty
```
int getIntegerProperty(String key,
                       int defaultValue)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A int value
  - getLongProperty
```
long getLongProperty(String key)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A long value
  - getLongProperty
```
long getLongProperty(String key,
                     long defaultValue)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A long value
  - getStringProperty
```
String getStringProperty(String key)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A String value
  - getStringProperty
```
String getStringProperty(String key,
                         String defaultValue)
```
    Retrieves a standard property by passing its key. The system will search, first on the server level, and finally in the *.properties files.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A String value
  - getStringArrayProperty
```
String[] getStringArrayProperty(String key)
```
    Retrieves standard property values by passing its key.
    
    Parameters:
    
    key - The key string.
    
    Returns:
    
    An array of String objects.
  - getProperties
```
Properties getProperties()
```
    Retrieves all standard properties
    
    Returns:
    
    A Properties object
  - getUserProperty
```
@Deprecated
String getUserProperty(String key)
```
    Deprecated. use getStringUserProperty() method instead.
    
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A string value
  - getBooleanUserProperty
```
boolean getBooleanUserProperty(String key)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A bool value
  - getBooleanUserProperty
```
boolean getBooleanUserProperty(String key,
                               boolean defaultValue)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A bool value
  - getDoubleUserProperty
```
double getDoubleUserProperty(String key)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A double value
  - getDoubleUserProperty
```
double getDoubleUserProperty(String key,
                             double defaultValue)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A double value
  - getBigDecimalUserProperty
```
BigDecimal getBigDecimalUserProperty(String key)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A BigDecimal value
  - getBigDecimalUserProperty
```
BigDecimal getBigDecimalUserProperty(String key,
                                     BigDecimal defaultValue)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A BigDecimal value
  - getFloatUserProperty
```
float getFloatUserProperty(String key)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A float value
  - getFloatUserProperty
```
float getFloatUserProperty(String key,
                           float defaultValue)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A float value
  - getIntegerUserProperty
```
int getIntegerUserProperty(String key)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A int value
  - getIntegerUserProperty
```
int getIntegerUserProperty(String key,
                           int defaultValue)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A int value
  - getLongUserProperty
```
long getLongUserProperty(String key)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A long value
  - getLongUserProperty
```
long getLongUserProperty(String key,
                         long defaultValue)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A long value
  - getObjectUserProperty
```
Object getObjectUserProperty(String key)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A Object value
  - getObjectUserProperty
```
Object getObjectUserProperty(String key,
                             Object defaultValue)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A Object value
  - getStringUserProperty
```
String getStringUserProperty(String key)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    Returns:
    
    A String value
  - getStringUserProperty
```
String getStringUserProperty(String key,
                             String defaultValue)
```
    Retrieves a specific property by passing its key. The properties can be specified in the 'User parameters' either on the server or a catalog. The system will search, first on the catalog level, then on the server level.
    
    Parameters:
    
    key - The key string
    
    defaultValue - The default value
    
    Returns:
    
    A String value
  - getUserProperties
```
Properties getUserProperties()
```
    Retreves all specific properties
    
    Returns:
    
    A Properties object

Interface IConfiguration

Nested Class Summary

Method Summary

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

Method Detail

getProperty

getBooleanProperty

getBooleanProperty

getDoubleProperty

getDoubleProperty

getBigDecimalProperty

getBigDecimalProperty

getFloatProperty

getFloatProperty

getIntegerProperty

getIntegerProperty

getLongProperty

getLongProperty

getStringProperty

getStringProperty

getStringArrayProperty

getProperties

getUserProperty

getBooleanUserProperty

getBooleanUserProperty

getDoubleUserProperty

getDoubleUserProperty

getBigDecimalUserProperty

getBigDecimalUserProperty

getFloatUserProperty

getFloatUserProperty

getIntegerUserProperty

getIntegerUserProperty

getLongUserProperty

getLongUserProperty

getObjectUserProperty

getObjectUserProperty

getStringUserProperty

getStringUserProperty

getUserProperties