Celtix User APIs

org.objectweb.celtix.configuration
Interface ConfigurationItemMetadata


public interface ConfigurationItemMetadata

Interface to access configuration metadata accessed at runtime. Acts as a restricted view on configuration metadata, e.g. does not provide access to a configuration item's documentation.


Nested Class Summary
static class ConfigurationItemMetadata.LifecyclePolicy
           
 
Method Summary
 Object getDefaultValue()
          Returns the default value of this configuration metadata item.
 ConfigurationItemMetadata.LifecyclePolicy getLifecyclePolicy()
          Returns the lifecycle policy for this configuration metadata item.
 String getName()
          Returns the name of this configuration metadata item which must be unique within its ConfigurationMetadata container.
 QName getType()
          Returns the type of this configuration metadata item as a QName.
 

Method Detail

getName

String getName()
Returns the name of this configuration metadata item which must be unique within its ConfigurationMetadata container.

Returns:
the name of the configuration item.

getType

QName getType()
Returns the type of this configuration metadata item as a QName. The namespaceURI of this QName identifies the XML schema containing the definition of the (complex or simple) type of this item. The local part identifies a global element in that schema that is of the underlying type.

Returns:
the type of this configuration metadata item.

getLifecyclePolicy

ConfigurationItemMetadata.LifecyclePolicy getLifecyclePolicy()
Returns the lifecycle policy for this configuration metadata item. Depending on this value, concrete instances of this configuration metadata item (configuration items) will have values that can never change, can be set once pre process/bus or can be modified ar any time.

Returns:
the lifecycle policy of this configuration metadata item.

getDefaultValue

Object getDefaultValue()
Returns the default value of this configuration metadata item. The runtime class of this value depends on the jaxb schema binding for the type of this item. For primitive data types it is a holder class, e.g. java.lang.Boolean.

Returns:
the default value of this configuration metadata item.

Celtix User APIs