API Documentation

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

diff --git a/org.argeo.slc.webapp/src/main/webapp/argeo-ria-lib/slc/class/org/argeo/slc/ria/execution/Value.js b/org.argeo.slc.webapp/src/main/webapp/argeo-ria-lib/slc/class/org/argeo/slc/ria/execution/Value.js
index 6ce99a06cc65ab19dcb870bdd413eb6f26d61afc..29556d88604e3e284d87c8329bab45c6c1ff5abb 100644 (file)
--- a/org.argeo.slc.webapp/src/main/webapp/argeo-ria-lib/slc/class/org/argeo/slc/ria/execution/Value.js
+++ b/org.argeo.slc.webapp/src/main/webapp/argeo-ria-lib/slc/class/org/argeo/slc/ria/execution/Value.js
@@ -13,22 +13,40 @@ qx.Class.define("org.argeo.slc.ria.execution.Value", {
                        check : "String",\r
                        init : ""\r
                },\r
+               /**\r
+                * The type of this value, for the moment "primitive" and "ref" are supported \r
+                */\r
                specType : {\r
                        check : "String",\r
                        init : ""                       \r
                },\r
+               /**\r
+                * Subtype, depending on the "type". \r
+                */\r
                specSubType : {\r
                        check : "String"\r
                },\r
+               /**\r
+                * Whether it is a parameter or not \r
+                */\r
                parameter : {\r
                        check : "Boolean"\r
                },\r
+               /**\r
+                * Whether it is frozen on the server, i.e. disabled in the form \r
+                */\r
                frozen : {\r
                        check : "Boolean"\r
                },\r
+               /**\r
+                * Should not be editable nor seeable, thus hidden \r
+                */\r
                hidden : {\r
                        check : "Boolean"\r
                },\r
+               /**\r
+                * The real value \r
+                */\r
                value : {\r
                        nullable : true\r
                },\r
@@ -77,6 +95,10 @@ qx.Class.define("org.argeo.slc.ria.execution.Value", {
                        }\r
                },\r
                \r
+               /**\r
+                * Apply the value from the node\r
+                * @param xmlNode {Node} Castor representation of this object\r
+                */\r
                _applyXmlValue : function(xmlNode){\r
                        var xpath;\r
                        if(this.getSpecType() == "primitive"){\r
@@ -87,6 +109,10 @@ qx.Class.define("org.argeo.slc.ria.execution.Value", {
                        this.setValue(org.argeo.ria.util.Element.getSingleNodeText(xmlNode, xpath));\r
                },\r
                \r
+               /**\r
+                * Create an XML Representation of this value\r
+                * @return {String} The XML String\r
+                */\r
                toXml : function(){\r
                        var valueTag = '<slc:value>'+this.getValue()+'</slc:value>';\r
                        var specAttribute = '';\r