X-Git-Url: http://git.argeo.org/?a=blobdiff_plain;ds=sidebyside;f=org.argeo.slc%2Fsrc%2Fmain%2Fjava%2Forg%2Fargeo%2Fslc%2Fcore%2Fstructure%2FStructureRegistry.java;fp=org.argeo.slc%2Fsrc%2Fmain%2Fjava%2Forg%2Fargeo%2Fslc%2Fcore%2Fstructure%2FStructureRegistry.java;h=3ffb2d26ff1caa15139f4794d7deafe312139e6a;hb=6e6998e19852f8209f955c0d2c773feca161d4d0;hp=f574784d85b118b2095fdf79ec7319f35634b0f2;hpb=0dd04925b1fb2600e0a120d5e6f4e4963eb23fd8;p=gpl%2Fargeo-slc.git

diff --git a/org.argeo.slc/src/main/java/org/argeo/slc/core/structure/StructureRegistry.java b/org.argeo.slc/src/main/java/org/argeo/slc/core/structure/StructureRegistry.java
index f574784d8..3ffb2d26f 100644
--- a/org.argeo.slc/src/main/java/org/argeo/slc/core/structure/StructureRegistry.java
+++ b/org.argeo.slc/src/main/java/org/argeo/slc/core/structure/StructureRegistry.java
@@ -2,20 +2,57 @@ package org.argeo.slc.core.structure;
 
 import java.util.List;
 
+/** Registry where the whole structure is stored. */
 public interface StructureRegistry {
+	/** Read mode: the structure is only read. */
 	public static String READ = "READ";
+	/** All mode: everything is executed regardless of the active paths. */
 	public static String ALL = "ALL";
+	/** Active mode: only teh active paths are executed. */
 	public static String ACTIVE = "ACTIVE";
-	
+
+	/** Adds an element to the registry. */
 	public void register(StructureElement element);
+
+	/**
+	 * Adds the wrapped element of a <code>SructureAware</code>, and
+	 * propagates the registration.
+	 */
 	public void register(StructureAware structureAware);
+
+	/** Lists <b>all</b> registered elements. */
 	public List<StructureElement> listElements();
-	
+
+	/** Gets a element based on its path. */
 	public StructureElement getElement(StructurePath path);
-	
+
+	/**
+	 * Set the interpreter mode: read, all or active.
+	 * 
+	 * @see #READ
+	 * @see #ALL
+	 * @see #ACTIVE
+	 */
 	public void setMode(String mode);
+
+	/**
+	 * Gets the current interpreter mode.
+	 * 
+	 * @see #READ
+	 * @see #ALL
+	 * @see #ACTIVE
+	 */
 	public String getMode();
-	
+
+	/**
+	 * Gets the list of active paths, which will be run if executed in
+	 * <code>ACTIVE</code> mode.
+	 */
 	public List<StructurePath> getActivePaths();
+
+	/**
+	 * Sets the list of active path, which will be run if executed in
+	 * <code>ACTIVE</code> mode.
+	 */
 	public void setActivePaths(List<StructurePath> activePaths);
 }