API Documentation

[gpl/argeo-slc.git] / org.argeo.slc.webapp / src / main / webapp / argeo-ria-lib / slc / class / org / argeo / slc / ria / execution / Flow.js

diff --git a/org.argeo.slc.webapp/src/main/webapp/argeo-ria-lib/slc/class/org/argeo/slc/ria/execution/Flow.js b/org.argeo.slc.webapp/src/main/webapp/argeo-ria-lib/slc/class/org/argeo/slc/ria/execution/Flow.js
index 124e14e8ab9f5ebe68c57f85c0c40e3755608d18..10473aa5ca037590e906ff24708e9c830dc4c018 100644 (file)
--- a/org.argeo.slc.webapp/src/main/webapp/argeo-ria-lib/slc/class/org/argeo/slc/ria/execution/Flow.js
+++ b/org.argeo.slc.webapp/src/main/webapp/argeo-ria-lib/slc/class/org/argeo/slc/ria/execution/Flow.js
@@ -25,6 +25,9 @@ qx.Class.define("org.argeo.slc.ria.execution.Flow", {
                executionSpec : {\r
                        check : "org.argeo.slc.ria.execution.Spec"\r
                },\r
+               /**\r
+                * The values to init the ExecutionSpec\r
+                */\r
                values : {\r
                        check : "Node"\r
                },\r
@@ -37,8 +40,17 @@ qx.Class.define("org.argeo.slc.ria.execution.Flow", {
        },\r
        \r
        statics : {\r
+               /**\r
+                * Xpath to the name \r
+                */\r
                XPATH_NAME : "@name",\r
+               /**\r
+                * XPath to the ExecutionSpec name\r
+                */\r
                XPATH_EXEC_SPEC_NAME : "@executionSpec",\r
+               /**\r
+                * XPath to the values\r
+                */\r
                XPATH_VALUES : "slc:values"\r
        },\r
        \r
@@ -59,6 +71,13 @@ qx.Class.define("org.argeo.slc.ria.execution.Flow", {
                        var values = org.argeo.ria.util.Element.selectNodes(xmlNode, this.self(arguments).XPATH_VALUES);\r
                        this.setValues(values[0]);\r
                },\r
+               /**\r
+                * Get a given value inside the values map\r
+                * @param key {String} The key of the value \r
+                * @param specType {String} Expected type (currently "primitive" and "ref" are supported)\r
+                * @param specSubType {String} Expected subtype (depends on the type)\r
+                * @return {String} Value if it is set.\r
+                */\r
                getValue: function(key, specType, specSubType){\r
                        var xpath;\r
                        if(specType == "primitive"){\r