X-Git-Url: http://git.argeo.org/?a=blobdiff_plain;f=runtime%2Forg.argeo.slc.specs%2Fsrc%2Fmain%2Fjava%2Forg%2Fargeo%2Fslc%2Fexecution%2FExecutionFlowDescriptor.java;h=77cc268169f81d0845b0f083f23049e357f02b69;hb=9bab32638cc6a08ba96c3feca190733e9d1ac0ac;hp=575886d9a09a10d6984b55eecf35deb74a5d0eab;hpb=d601802d5a50e4e30eb639a08eff5270b63fe599;p=gpl%2Fargeo-slc.git

diff --git a/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/execution/ExecutionFlowDescriptor.java b/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/execution/ExecutionFlowDescriptor.java
index 575886d9a..77cc26816 100644
--- a/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/execution/ExecutionFlowDescriptor.java
+++ b/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/execution/ExecutionFlowDescriptor.java
@@ -19,6 +19,27 @@ package org.argeo.slc.execution;
 import java.io.Serializable;
 import java.util.Map;
 
+/**
+ * 
+ * Implements both archetype and implementation of a given process.
+ * 
+ * At specification time, <code>executionSpec</code> represents the spec of the
+ * parameters accepted by the process, with, among others: type, default value
+ * and, optionally, possible values for each parameter. Thus ExecutionSpec might
+ * be a huge object. Note that when marshalling only a reference to a specific
+ * ExecutionSpec is stored in the XML to optimize performance and avoid
+ * redundancy between various ExecutionFlowDesciptor that might have the same
+ * ExecutionSpec.
+ * 
+ * At runtime, we build a RealizedFlow which references an
+ * ExecutionFlowDescriptor. As it happens AFTER marshalling / unmarshalling
+ * process, the ExecutionSpec is null but we manage to retrieve the
+ * ExecutionSpec and store it in the RealizedFlow, whereas set values of the
+ * parameters are stored in the <code>values</code> map.
+ * 
+ * Generally, values object are either a <code>PrimitiveAccessor</code> or a
+ * <code>RefValue</code> but can be other objects.
+ */
 public class ExecutionFlowDescriptor implements Serializable {
 	private static final long serialVersionUID = 7101944857038041216L;
 	private String name;
@@ -41,10 +62,18 @@ public class ExecutionFlowDescriptor implements Serializable {
 		return name;
 	}
 
+	/**
+	 * @deprecated will be removed in SLC 2.0, the path should be the part of
+	 *             the name with '/'
+	 */
 	public String getPath() {
 		return path;
 	}
 
+	/**
+	 * @deprecated will be removed in SLC 2.0, the path should be the part of
+	 *             the name with '/'
+	 */
 	public void setPath(String path) {
 		this.path = path;
 	}