com.filenet.rm.bds

Interface Configuration


  1. public interface Configuration
This interface represents the collection of Bulk Declaration Service configuration items that are used to control its runtime behavior. Each member of this collection is uniquely identified by by one of the ConfigItemType constants.

Method Summary

Modifier and Type Method and Description
  1. java.util.Set
getConfigItemKeys()
Returns a Set of ConfigItemType that represent the keys of the Configuration collection.
  1. DataType
getItemDataType(ConfigItemType itemType)
Returns the enumberated DataType value corresponding to the specified ConfigItemType.
  1. java.lang.String
getItemDescription(ConfigItemType itemType)
Returns the localized description String of the specified configuration item for the default Locale.
  1. java.lang.String
getItemDescription(ConfigItemType itemType,java.util.Locale locale)
Returns the localized description String of the specified configuration item for the specified Locale.
  1. boolean
getItemValueAsBool(ConfigItemType itemType)
Returns the boolean value for a configuration item of type DataType.TYPE_BOOLEAN.
  1. int
getItemValueAsInt(ConfigItemType itemType)
Returns the int value for a configuration item of type DataType.TYPE_INTEGER.
  1. java.lang.String
getItemValueAsString(ConfigItemType itemType)
Returns the String value for a configuration item of type DataType.TYPE_STRING.
  1. void
setItemValue(ConfigItemType itemType,boolean value)
Sets the value for a configuration item of type DataType.TYPE_BOOLEAN.
  1. void
setItemValue(ConfigItemType itemType,int value)
Sets the value for a configuration item of type DataType.TYPE_INTEGER.
  1. void
setItemValue(ConfigItemType itemType,java.lang.String value)
Sets the value for a configuration item of type DataType.TYPE_STRING.

Method Detail

getConfigItemKeys

  1. java.util.Set getConfigItemKeys( )
Returns a Set of ConfigItemType that represent the keys of the Configuration collection.
Returns:
a Set of ConfigItemType instances.

getItemDescription

  1. java.lang.String getItemDescription( ConfigItemType itemType,
  2. 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

  1. 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

  1. DataType getItemDataType(ConfigItemType itemType)
Returns the enumberated DataType value corresponding to the specified ConfigItemType.
Parameters:
itemType - the ConfigItemType identifier.
Returns:
the associated DataType value.

getItemValueAsBool

  1. 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

  1. 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

  1. 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

  1. void setItemValue(ConfigItemType itemType,
  2. 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

  1. void setItemValue(ConfigItemType itemType,
  2. 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

  1. void setItemValue(ConfigItemType itemType,
  2. 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.