ConfigurationItemMetadata


1   package org.objectweb.celtix.configuration;
2   
3   import javax.xml.namespace.QName  ;
4   
5   /**
6    * Interface to access configuration metadata accessed at runtime.
7    * Acts as a restricted view on configuration metadata, e.g. does 
8    * not provide access to a configuration item's documentation. 
9    */
10  public interface ConfigurationItemMetadata {
11      
12      public enum LifecyclePolicy {
13          STATIC,
14          PROCESS,
15          BUS,
16          DYNAMIC
17      };
18      
19      /**
20       * Returns the name of this configuration metadata item which must be unique within 
21       * its <code>ConfigurationMetadata</code> container.
22       * 
23       * @return the name of the configuration item.
24       */
25      String   getName();
26      
27      /** 
28       * Returns the type of this configuration metadata item as a <code>QName</code>.
29       * The namespaceURI of this <code>QName</code> identifies the XML schema containing the 
30       * definition of the (complex or simple) type of this item. The local part 
31       * identifies a global element in that schema that is of the underlying type.
32       * 
33       * @return the type of this configuration metadata item.
34       */
35      QName   getType();
36  
37      /**
38       * Returns the lifecycle policy for this configuration metadata item. Depending on this value,
39       * concrete instances of this configuration metadata item (configuration items) will have values that
40       * can never change, can be set once pre process/bus or can be modified ar any time. 
41       * 
42       * @return the lifecycle policy of this configuration metadata item.
43       */
44      LifecyclePolicy getLifecyclePolicy();
45      
46      /** 
47       * Returns the default value of this configuration metadata item. The runtime class of this value 
48       * depends on the jaxb schema binding for the type of this item. For primitive data types it 
49       * is a holder class, e.g. java.lang.Boolean.
50       * 
51       * @return the default value of this configuration metadata item.
52       */
53      Object   getDefaultValue();
54      
55  }
56
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags