com.filenet.rm.bds
Interface Configuration
- public interface Configuration
ConfigItemType
constants.
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getConfigItemKeys()
Returns a
Set of ConfigItemType that represent the keys
of the Configuration collection.
|
getItemDataType(ConfigItemType itemType)
Returns the enumberated
DataType value corresponding to the specified
ConfigItemType .
|
|
|
getItemDescription(ConfigItemType itemType)
Returns the localized description
String of the specified
configuration item for the default Locale .
|
|
getItemDescription(ConfigItemType itemType,java.util.Locale locale)
Returns the localized description
String of the specified
configuration item for the specified Locale .
|
|
getItemValueAsBool(ConfigItemType itemType)
Returns the
boolean value for a configuration item of type DataType.TYPE_BOOLEAN .
|
|
getItemValueAsInt(ConfigItemType itemType)
Returns the
int value for a configuration item of type DataType.TYPE_INTEGER .
|
|
getItemValueAsString(ConfigItemType itemType)
Returns the
String value for a configuration item of type DataType.TYPE_STRING .
|
|
setItemValue(ConfigItemType itemType,boolean value)
Sets the value for a configuration item of type
DataType.TYPE_BOOLEAN .
|
|
setItemValue(ConfigItemType itemType,int value)
Sets the value for a configuration item of type
DataType.TYPE_INTEGER .
|
|
setItemValue(ConfigItemType itemType,java.lang.String value)
Sets the value for a configuration item of type
DataType.TYPE_STRING .
|
Method Detail
getConfigItemKeys
- java.util.Set getConfigItemKeys( )
Returns:
a
Set
of ConfigItemType
instances. getItemDescription
- java.lang.String getItemDescription( ConfigItemType itemType,
- java.util.Locale locale)
Returns the localized description
String
of the specified
configuration item for the specified Locale
.
Parameters:
itemType
- the item's ConfigItemType
identifier locale
- the Locale
to base the description String
upon. Returns:
the localized
String
description. getItemDescription
- java.lang.String getItemDescription( ConfigItemType itemType)
Returns the localized description
String
of the specified
configuration item for the default Locale
.
Parameters:
itemType
- the item's ConfigItemType
identifier Returns:
the localized
String
description. getItemDataType
- DataType getItemDataType(ConfigItemType itemType)
Returns the enumberated
DataType
value corresponding to the specified
ConfigItemType
.
getItemValueAsBool
- boolean getItemValueAsBool(ConfigItemType itemType)
Returns the
boolean
value for a configuration item of type
DataType.TYPE_BOOLEAN
.
Parameters:
itemType
- the ConfigItemType
identifier. Returns:
the configuration item's
boolean
value. Throws:
BDSException
- if configuration item's type is not DataType.TYPE_BOOLEAN
. getItemValueAsInt
- int getItemValueAsInt(ConfigItemType itemType)
Returns the
int
value for a configuration item of type
DataType.TYPE_INTEGER
.
Parameters:
itemType
- the ConfigItemType
identifier. Returns:
the configuration item's
int
value. Throws:
BDSException
- if configuration item's type is not DataType.TYPE_INTEGER
. getItemValueAsString
- java.lang.String getItemValueAsString( ConfigItemType itemType)
Returns the
String
value for a configuration item of type
DataType.TYPE_STRING
.
Parameters:
itemType
- the ConfigItemType
identifier. Returns:
the configuration item's
String
value. Throws:
BDSException
- if configuration item's type is not DataType.TYPE_STRING
. setItemValue
- void setItemValue(ConfigItemType itemType,
- boolean value)
Sets the value for a configuration item of type
DataType.TYPE_BOOLEAN
.
Parameters:
itemType
- the ConfigItemType
identifier. value
- the new boolean
configuration value. Throws:
BDSException
- if configuration item's type is not DataType.TYPE_BOOLEAN
. setItemValue
- void setItemValue(ConfigItemType itemType,
- int value)
Sets the value for a configuration item of type
DataType.TYPE_INTEGER
.
Parameters:
itemType
- the ConfigItemType
identifier. value
- the new int
configuration value. Throws:
BDSException
- if configuration item's type is not DataType.TYPE_INTEGER
. setItemValue
- void setItemValue(ConfigItemType itemType,
- java.lang.String value)
Sets the value for a configuration item of type
DataType.TYPE_STRING
.
Parameters:
itemType
- the ConfigItemType
identifier. value
- the new String
configuration value. Throws:
BDSException
- if configuration item's type is not DataType.TYPE_STRING
.
Set
ofConfigItemType
that represent the keys of the Configuration collection.