com.eibus.management

Interface ISettingsCollection

All Superinterfaces:

java.lang.Iterable<ISettingDefinition<?>>

public interface ISettingsCollection
extends java.lang.Iterable<ISettingDefinition<?>>

This interface describes a collection of settings.

Author:

Bert Roos

Method Summary

Modifier and Type	Method and Description
<T> T	defineColdSetting(java.lang.String name, ILocalizableString description, java.lang.String legacyProperty, java.lang.Class<T> propertyType) Defines an 'cold' setting with a given name and description.
<T> T	defineColdSetting(java.lang.String name, ILocalizableString description, java.lang.String legacyProperty, T defaultValue) Defines an 'cold' setting with a given name, description and default value.
<T> T	defineColdSetting(java.lang.String name, ILocalizableString description, java.lang.String legacyProperty, T defaultValue, java.lang.Comparable<T> minValue, java.lang.Comparable<T> maxValue) Defines a 'cold' setting with a given name, description, default value and min and max value.
<T> T	defineColdSetting(java.lang.String name, ILocalizableString description, java.lang.String legacyProperty, T defaultValue, T[] legalValues) Defines a 'cold' setting with a given name, description, default value and set of legal values.
<T> T	defineColdSetting(java.lang.String name, java.lang.String description, java.lang.String legacyProperty, java.lang.Class<T> propertyType) Deprecated. since C2. Use the localizable version of this method instead.
<T> T	defineColdSetting(java.lang.String name, java.lang.String description, java.lang.String legacyProperty, T defaultValue) Deprecated. since C2. Use the localizable version of this method instead.
<T> T	defineColdSetting(java.lang.String name, java.lang.String description, java.lang.String legacyProperty, T defaultValue, java.lang.Comparable<T> minValue, java.lang.Comparable<T> maxValue) Deprecated. since C2. Use the localizable version of this method instead.
<T> T	defineColdSetting(java.lang.String name, java.lang.String description, java.lang.String legacyProperty, T defaultValue, T[] legalValues) Deprecated. since C2. Use the localizable version of this method instead.
java.lang.Object	defineHotSetting(java.lang.String name, ILocalizableString description, java.lang.String propertyImplName, java.lang.Object propertyImpl, java.lang.String legacyProperty) Defines an 'hot' setting with a given name and description.
<T> T	defineHotSetting(java.lang.String name, ILocalizableString description, java.lang.String propertyImplName, java.lang.Object propertyImpl, java.lang.String legacyProperty, T defaultValue) Defines an 'hot' setting with a given name, description and default value.
<T> T	defineHotSetting(java.lang.String name, ILocalizableString description, java.lang.String propertyImplName, java.lang.Object propertyImpl, java.lang.String legacyProperty, T defaultValue, java.lang.Comparable<T> minValue, java.lang.Comparable<T> maxValue) Defines a 'hot' setting with a given name, description, default value and min and max value.
<T> T	defineHotSetting(java.lang.String name, ILocalizableString description, java.lang.String propertyImplName, java.lang.Object propertyImpl, java.lang.String legacyProperty, T defaultValue, T[] legalValues) Defines a 'hot' setting with a given name, description, default value and set of legal values.
java.lang.Object	defineHotSetting(java.lang.String name, java.lang.String description, java.lang.String propertyImplName, java.lang.Object propertyImpl, java.lang.String legacyProperty) Deprecated. since C2. Use the localizable version of this method instead.
<T> T	defineHotSetting(java.lang.String name, java.lang.String description, java.lang.String propertyImplName, java.lang.Object propertyImpl, java.lang.String legacyProperty, T defaultValue) Deprecated. since C2. Use the localizable version of this method instead.
<T> T	defineHotSetting(java.lang.String name, java.lang.String description, java.lang.String propertyImplName, java.lang.Object propertyImpl, java.lang.String legacyProperty, T defaultValue, java.lang.Comparable<T> minValue, java.lang.Comparable<T> maxValue) Deprecated. since C2. Use the localizable version of this method instead.
<T> T	defineHotSetting(java.lang.String name, java.lang.String description, java.lang.String propertyImplName, java.lang.Object propertyImpl, java.lang.String legacyProperty, T defaultValue, T[] legalValues) Deprecated. since C2. Use the localizable version of this method instead.
<T> T	defineWriteOnlyColdSetting(java.lang.String name, ILocalizableString description, java.lang.String legacyProperty, java.lang.Class<T> propertyType) Defines a write-only 'cold' setting with a given name and description.
<T> T	defineWriteOnlyColdSetting(java.lang.String name, java.lang.String description, java.lang.String legacyProperty, java.lang.Class<T> propertyType) Deprecated. since C2. Use the localizable version of this method instead.
java.lang.Object	defineWriteOnlyHotSetting(java.lang.String name, ILocalizableString description, java.lang.String propertyImplName, java.lang.Object propertyImpl, java.lang.String legacyProperty) Defines a write-only hot setting with a given name and description.
java.lang.Object	defineWriteOnlyHotSetting(java.lang.String name, java.lang.String description, java.lang.String propertyImplName, java.lang.Object propertyImpl, java.lang.String legacyProperty) Deprecated. since C2. Use the localizable version of this method instead.
IManagedComponent	getManagedComponent() Retrieves the managed component on which this settings collection is defined.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

defineHotSetting

java.lang.Object defineHotSetting(java.lang.String name,
                                  java.lang.String description,
                                  java.lang.String propertyImplName,
                                  java.lang.Object propertyImpl,
                                  java.lang.String legacyProperty)

Deprecated. since C2. Use the localizable version of this method instead.

Defines an 'hot' setting with a given name and description. A 'hot' setting is immediately used, without requiring a restart of the process.

Parameters:

name - cannot be a null or empty string.

description - cannot be a null or empty string.

propertyImplName - the name of the property on the implementing object. When null, the property name is used.

propertyImpl - the object implementing the object. When null, the managed component is used instead.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

Returns:

the initial value of the newly created setting definition

defineHotSetting

<T> T defineHotSetting(java.lang.String name,
                       java.lang.String description,
                       java.lang.String propertyImplName,
                       java.lang.Object propertyImpl,
                       java.lang.String legacyProperty,
                       T defaultValue)

Deprecated. since C2. Use the localizable version of this method instead.

Defines an 'hot' setting with a given name, description and default value. A 'hot' setting is immediately used, without requiring a restart of the process.

Parameters:

name - cannot be a null or empty string.

description - cannot be a null or empty string.

propertyImplName - the name of the property on the implementing object. When null, the property name is used.

propertyImpl - the object implementing the object. When null, the managed component is used instead.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

Returns:

the initial value of the newly created setting definition

defineHotSetting

<T> T defineHotSetting(java.lang.String name,
                       java.lang.String description,
                       java.lang.String propertyImplName,
                       java.lang.Object propertyImpl,
                       java.lang.String legacyProperty,
                       T defaultValue,
                       java.lang.Comparable<T> minValue,
                       java.lang.Comparable<T> maxValue)

Deprecated. since C2. Use the localizable version of this method instead.

Defines a 'hot' setting with a given name, description, default value and min and max value. A 'hot' setting is immediately used, without requiring a restart of the process.

Parameters:

name - cannot be a null or empty string.

description - cannot be a null or empty string.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

propertyImplName - the name of the property on the implementing object. When null, the property name is used.

propertyImpl - the object implementing the object. When null, the managed component is used instead.

defaultValue - must be a valid value for the openType specified for this setting; default value not supported for ArrayType and TabularType; can be null, in which case it means that no default value is set.

minValue - must be valid for the openType specified for this setting; can be null, in which case it means that no minimal value is set.

maxValue - must be valid for the openType specified for this setting; can be null, in which case it means that no maximal value is set.

Returns:

the initial value of the newly created setting definition

defineHotSetting

<T> T defineHotSetting(java.lang.String name,
                       java.lang.String description,
                       java.lang.String propertyImplName,
                       java.lang.Object propertyImpl,
                       java.lang.String legacyProperty,
                       T defaultValue,
                       T[] legalValues)

Deprecated. since C2. Use the localizable version of this method instead.

Defines a 'hot' setting with a given name, description, default value and set of legal values. A 'hot' setting is immediately used, without requiring a restart of the process.

Parameters:

name - cannot be a null or empty string.

description - cannot be a null or empty string.

propertyImplName - the name of the property on the implementing object. When null, the property name is used.

propertyImpl - the object implementing the object. When null, the managed component is used instead.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

defaultValue - must be a valid value for the openType specified for this setting; default value not supported for ArrayType and TabularType; can be null, in which case it means that no default value is set.

legalValues - contained value must be valid for the openType specified for this setting; legal values not supported for ArrayType and TabularType; can be null or empty

Returns:

the initial value of the newly created setting definition

defineWriteOnlyHotSetting

java.lang.Object defineWriteOnlyHotSetting(java.lang.String name,
                                           java.lang.String description,
                                           java.lang.String propertyImplName,
                                           java.lang.Object propertyImpl,
                                           java.lang.String legacyProperty)

Deprecated. since C2. Use the localizable version of this method instead.

Defines a write-only hot setting with a given name and description. A 'hot' setting is immediately used, without requiring a restart of the process.

Parameters:

name - cannot be a null or empty string.

description - cannot be a null or empty string.

propertyImplName - the name of the property on the implementing object. When null, the property name is used.

propertyImpl - the object implementing the object. When null, the managed component is used instead.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

Returns:

the initial value of the newly created setting definition

defineColdSetting

<T> T defineColdSetting(java.lang.String name,
                        java.lang.String description,
                        java.lang.String legacyProperty,
                        java.lang.Class<T> propertyType)

Deprecated. since C2. Use the localizable version of this method instead.

Defines an 'cold' setting with a given name and description. A 'cold' setting requires a restart of the process to become actual.

Parameters:

name - cannot be a null or empty string.

description - cannot be a null or empty string.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

propertyType - the type of the property

Returns:

the initial value of the newly created setting definition

defineColdSetting

<T> T defineColdSetting(java.lang.String name,
                        java.lang.String description,
                        java.lang.String legacyProperty,
                        T defaultValue)

Deprecated. since C2. Use the localizable version of this method instead.

Defines an 'cold' setting with a given name, description and default value. A 'cold' setting requires a restart of the process to become actual.

Parameters:

name - cannot be a null or empty string.

description - cannot be a null or empty string.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

Returns:

the initial value of the newly created setting definition

defineColdSetting

<T> T defineColdSetting(java.lang.String name,
                        java.lang.String description,
                        java.lang.String legacyProperty,
                        T defaultValue,
                        java.lang.Comparable<T> minValue,
                        java.lang.Comparable<T> maxValue)

Deprecated. since C2. Use the localizable version of this method instead.

Defines a 'cold' setting with a given name, description, default value and min and max value. A 'cold' setting requires a restart of the process to become actual.

Parameters:

name - cannot be a null or empty string.

description - cannot be a null or empty string.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

defaultValue - must be a valid value for the openType specified for this setting; default value not supported for ArrayType and TabularType; can be null, in which case it means that no default value is set.

minValue - must be valid for the openType specified for this setting; can be null, in which case it means that no minimal value is set.

maxValue - must be valid for the openType specified for this setting; can be null, in which case it means that no maximal value is set.

Returns:

the initial value of the newly created setting definition

defineColdSetting

<T> T defineColdSetting(java.lang.String name,
                        java.lang.String description,
                        java.lang.String legacyProperty,
                        T defaultValue,
                        T[] legalValues)

Deprecated. since C2. Use the localizable version of this method instead.

Defines a 'cold' setting with a given name, description, default value and set of legal values. A 'cold' setting requires a restart of the process to become actual.

Parameters:

name - cannot be a null or empty string.

description - cannot be a null or empty string.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

defaultValue - must be a valid value for the openType specified for this setting; default value not supported for ArrayType and TabularType; can be null, in which case it means that no default value is set.

legalValues - contained value must be valid for the openType specified for this setting; legal values not supported for ArrayType and TabularType; can be null or empty

Returns:

the initial value of the newly created setting definition

defineWriteOnlyColdSetting

<T> T defineWriteOnlyColdSetting(java.lang.String name,
                                 java.lang.String description,
                                 java.lang.String legacyProperty,
                                 java.lang.Class<T> propertyType)

Deprecated. since C2. Use the localizable version of this method instead.

Defines a write-only 'cold' setting with a given name and description. A 'cold' setting requires a restart of the process to become actual.

Parameters:

name - cannot be a null or empty string.

description - cannot be a null or empty string.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

propertyType - the type of the property

Returns:

the initial value of the newly created setting definition

defineHotSetting

java.lang.Object defineHotSetting(java.lang.String name,
                                  ILocalizableString description,
                                  java.lang.String propertyImplName,
                                  java.lang.Object propertyImpl,
                                  java.lang.String legacyProperty)

Defines an 'hot' setting with a given name and description. A 'hot' setting is immediately used, without requiring a restart of the process.

Parameters:

name - cannot be a null or empty string.

description - Localizable description of this setting (cannot be null)

propertyImplName - the name of the property on the implementing object. When null, the property name is used.

propertyImpl - the object implementing the object. When null, the managed component is used instead.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

Returns:

the initial value of the newly created setting definition

defineHotSetting

<T> T defineHotSetting(java.lang.String name,
                       ILocalizableString description,
                       java.lang.String propertyImplName,
                       java.lang.Object propertyImpl,
                       java.lang.String legacyProperty,
                       T defaultValue)

Defines an 'hot' setting with a given name, description and default value. A 'hot' setting is immediately used, without requiring a restart of the process.

Parameters:

name - cannot be a null or empty string.

description - Localizable description of this setting (cannot be null)

propertyImplName - the name of the property on the implementing object. When null, the property name is used.

propertyImpl - the object implementing the object. When null, the managed component is used instead.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

Returns:

the initial value of the newly created setting definition

defineHotSetting

<T> T defineHotSetting(java.lang.String name,
                       ILocalizableString description,
                       java.lang.String propertyImplName,
                       java.lang.Object propertyImpl,
                       java.lang.String legacyProperty,
                       T defaultValue,
                       java.lang.Comparable<T> minValue,
                       java.lang.Comparable<T> maxValue)

Defines a 'hot' setting with a given name, description, default value and min and max value. A 'hot' setting is immediately used, without requiring a restart of the process.

Parameters:

name - cannot be a null or empty string.

description - Localizable description of this setting (cannot be null)

legacyProperty - Either XPath expression or String prefixed with WCPProp:

propertyImplName - the name of the property on the implementing object. When null, the property name is used.

propertyImpl - the object implementing the object. When null, the managed component is used instead.

defaultValue - must be a valid value for the openType specified for this setting; default value not supported for ArrayType and TabularType; can be null, in which case it means that no default value is set.

minValue - must be valid for the openType specified for this setting; can be null, in which case it means that no minimal value is set.

maxValue - must be valid for the openType specified for this setting; can be null, in which case it means that no maximal value is set.

Returns:

the initial value of the newly created setting definition

defineHotSetting

<T> T defineHotSetting(java.lang.String name,
                       ILocalizableString description,
                       java.lang.String propertyImplName,
                       java.lang.Object propertyImpl,
                       java.lang.String legacyProperty,
                       T defaultValue,
                       T[] legalValues)

Defines a 'hot' setting with a given name, description, default value and set of legal values. A 'hot' setting is immediately used, without requiring a restart of the process.

Parameters:

name - cannot be a null or empty string.

description - Localizable description of this setting (cannot be null)

propertyImplName - the name of the property on the implementing object. When null, the property name is used.

propertyImpl - the object implementing the object. When null, the managed component is used instead.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

defaultValue - must be a valid value for the openType specified for this setting; default value not supported for ArrayType and TabularType; can be null, in which case it means that no default value is set.

legalValues - contained value must be valid for the openType specified for this setting; legal values not supported for ArrayType and TabularType; can be null or empty

Returns:

the initial value of the newly created setting definition

defineWriteOnlyHotSetting

java.lang.Object defineWriteOnlyHotSetting(java.lang.String name,
                                           ILocalizableString description,
                                           java.lang.String propertyImplName,
                                           java.lang.Object propertyImpl,
                                           java.lang.String legacyProperty)

Defines a write-only hot setting with a given name and description. A 'hot' setting is immediately used, without requiring a restart of the process.

Parameters:

name - cannot be a null or empty string.

description - Localizable description of this setting (cannot be null)

propertyImplName - the name of the property on the implementing object. When null, the property name is used.

propertyImpl - the object implementing the object. When null, the managed component is used instead.

legacyProperty - Either XPath expression or String prefixed with WCPProp:

Returns:

the initial value of the newly created setting definition

defineColdSetting

<T> T defineColdSetting(java.lang.String name,
                        ILocalizableString description,
                        java.lang.String legacyProperty,
                        java.lang.Class<T> propertyType)

Defines an 'cold' setting with a given name and description. A 'cold' setting requires a restart of the process to become actual.

Parameters:

name - cannot be a null or empty string.

description - Localizable description of this setting (cannot be null)

legacyProperty - Either XPath expression or String prefixed with WCPProp:

propertyType - the type of the property

Returns:

the initial value of the newly created setting definition

defineColdSetting

<T> T defineColdSetting(java.lang.String name,
                        ILocalizableString description,
                        java.lang.String legacyProperty,
                        T defaultValue)

Defines an 'cold' setting with a given name, description and default value. A 'cold' setting requires a restart of the process to become actual.

Parameters:

name - cannot be a null or empty string.

description - Localizable description of this setting (cannot be null)

legacyProperty - Either XPath expression or String prefixed with WCPProp:

Returns:

the initial value of the newly created setting definition

defineColdSetting

<T> T defineColdSetting(java.lang.String name,
                        ILocalizableString description,
                        java.lang.String legacyProperty,
                        T defaultValue,
                        java.lang.Comparable<T> minValue,
                        java.lang.Comparable<T> maxValue)

Defines a 'cold' setting with a given name, description, default value and min and max value. A 'cold' setting requires a restart of the process to become actual.

Parameters:

name - cannot be a null or empty string.

description - Localizable description of this setting (cannot be null)

legacyProperty - Either XPath expression or String prefixed with WCPProp:

defaultValue - must be a valid value for the openType specified for this setting; default value not supported for ArrayType and TabularType; can be null, in which case it means that no default value is set.

minValue - must be valid for the openType specified for this setting; can be null, in which case it means that no minimal value is set.

maxValue - must be valid for the openType specified for this setting; can be null, in which case it means that no maximal value is set.

Returns:

the initial value of the newly created setting definition

defineColdSetting

<T> T defineColdSetting(java.lang.String name,
                        ILocalizableString description,
                        java.lang.String legacyProperty,
                        T defaultValue,
                        T[] legalValues)

Defines a 'cold' setting with a given name, description, default value and set of legal values. A 'cold' setting requires a restart of the process to become actual.

Parameters:

name - cannot be a null or empty string.

description - Localizable description of this setting (cannot be null)

legacyProperty - Either XPath expression or String prefixed with WCPProp:

defaultValue - must be a valid value for the openType specified for this setting; default value not supported for ArrayType and TabularType; can be null, in which case it means that no default value is set.

legalValues - contained value must be valid for the openType specified for this setting; legal values not supported for ArrayType and TabularType; can be null or empty

Returns:

the initial value of the newly created setting definition

defineWriteOnlyColdSetting

<T> T defineWriteOnlyColdSetting(java.lang.String name,
                                 ILocalizableString description,
                                 java.lang.String legacyProperty,
                                 java.lang.Class<T> propertyType)

Defines a write-only 'cold' setting with a given name and description. A 'cold' setting requires a restart of the process to become actual.

Parameters:

name - cannot be a null or empty string.

description - Localizable description of this setting (cannot be null)

legacyProperty - Either XPath expression or String prefixed with WCPProp:

propertyType - the type of the property

Returns:

the initial value of the newly created setting definition

getManagedComponent

IManagedComponent getManagedComponent()

Retrieves the managed component on which this settings collection is defined.

Returns:

the managed component on which this settings collection is defined.