DPML Notify

[mcconnell AT dpml.net]

Author: mcconnell AT dpml.net
Date: Wed Jul  6 23:42:55 2005
New Revision: 2999

Modified:
   
development/main/transit/core/handler/src/main/net/dpml/transit/store/ContentRegistryHome.java
   
development/main/transit/core/handler/src/main/net/dpml/transit/store/LayoutRegistryHome.java
Log:
javadoc

Modified: 
development/main/transit/core/handler/src/main/net/dpml/transit/store/ContentRegistryHome.java
==============================================================================
--- 
development/main/transit/core/handler/src/main/net/dpml/transit/store/ContentRegistryHome.java
      (original)
+++ 
development/main/transit/core/handler/src/main/net/dpml/transit/store/ContentRegistryHome.java
      Wed Jul  6 23:42:55 2005
@@ -21,16 +21,35 @@
 import java.net.URI;
 
 /**
- * 
+ * Interface implemented by classes providing content handler configuration
+ * stroage management.
  *
  * @author <a href="http://www.dpml.net";>The Digital Product Meta Library</a>
  */
 public interface ContentRegistryHome extends CodeBaseStorage
 {
+   /**
+    * Return an aray of the content staorage units initally assigned under
+    * the content registry storage home.
+    * 
+    * @return an array of content storage units
+    */
     ContentStorage[] getInitialContentStores();
 
+   /**
+    * Create a content storage unit for the supplied content type.
+    * @param type the content type
+    * @return the content storage unit
+    */
     ContentStorage createContentStorage( String type );
 
+   /**
+    * Create a content storage unit using a supplied type, title and uri.
+    * @param type the content type
+    * @param title the content type title
+    * @param uri a plugin codebase uri
+    * return the content storage unit
+    */
     ContentStorage createContentStorage( String type, String title, URI uri 
);
 
 }

Modified: 
development/main/transit/core/handler/src/main/net/dpml/transit/store/LayoutRegistryHome.java
==============================================================================
--- 
development/main/transit/core/handler/src/main/net/dpml/transit/store/LayoutRegistryHome.java
       (original)
+++ 
development/main/transit/core/handler/src/main/net/dpml/transit/store/LayoutRegistryHome.java
       Wed Jul  6 23:42:55 2005
@@ -19,13 +19,26 @@
 package net.dpml.transit.store;
 
 /**
- * The ProxyManager is an interface implemented by proxy managers.
+ * The LayoutRegistryHome is an interface implemented by objects
+ * providing services supporting the management of a collection of 
+ * layout configurations.
  *
  * @author <a href="http://www.dpml.net";>The Digital Product Meta Library</a>
  */
 public interface LayoutRegistryHome extends CodeBaseStorage
 {
+   /**
+    * Return the array of inital layout storage units.
+    * @return the layout unit storage array
+    */
     LayoutStorage[] getInitialLayoutStores();
 
+   /**
+    * Return a layout storage unit given a storae unit identifier.  If the 
+    * stroage unit does not exist an implementation shall create and return 
a 
+    * net storage unit.
+    * 
+    * @return the layout storage unit
+    */
     LayoutStorage getLayoutStorage( String id );
 }