API DOCUMENTATION

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

diff --git a/org.argeo.slc.webapp/src/main/webapp/argeo-ria-lib/slc/class/org/argeo/slc/ria/SlcExecutionMessage.js b/org.argeo.slc.webapp/src/main/webapp/argeo-ria-lib/slc/class/org/argeo/slc/ria/SlcExecutionMessage.js
index c9194f7f3eedce9d70747d5c1c02d2d87e4d6d3a..012ac49928bbc13f0f6e0449b01295a292858859 100644 (file)
--- a/org.argeo.slc.webapp/src/main/webapp/argeo-ria-lib/slc/class/org/argeo/slc/ria/SlcExecutionMessage.js
+++ b/org.argeo.slc.webapp/src/main/webapp/argeo-ria-lib/slc/class/org/argeo/slc/ria/SlcExecutionMessage.js
@@ -3,6 +3,10 @@
  */\r
 qx.Class.define("org.argeo.slc.ria.SlcExecutionMessage", {\r
        extend : qx.core.Object,\r
+       /**\r
+        * New instance\r
+        * @param uuid {String} The Uuid of the message. If none is passed, one is generated.\r
+        */\r
        construct : function(uuid){\r
                this.base(arguments);\r
                if(uuid){\r
@@ -54,6 +58,9 @@ qx.Class.define("org.argeo.slc.ria.SlcExecutionMessage", {
                        check : "String",\r
                        init : "user"\r
                },\r
+               /**\r
+                * Date of the message. now() by default.\r
+                */\r
                date : {\r
                        check : "String", \r
                        init : new Date().toString()\r
@@ -67,6 +74,11 @@ qx.Class.define("org.argeo.slc.ria.SlcExecutionMessage", {
        },\r
        members : {\r
                \r
+               /**\r
+                * Add a free attribute to the message\r
+                * @param attName {String} Name\r
+                * @param attValue {String} Value\r
+                */\r
                addAttribute: function(attName, attValue){\r
                        var attr = this.getAttributes();\r
                        attr[attName] = attValue;\r
@@ -96,6 +108,10 @@ qx.Class.define("org.argeo.slc.ria.SlcExecutionMessage", {
                        return builder.get();\r
                },\r
                \r
+               /**\r
+                * Parse an XML answer and fill the object with it.\r
+                * @param slcExecXml {String} An slcExecMessage mapped in XML.\r
+                */\r
                fromXml : function(slcExecXml){\r
                        var NSMap = {slc:"http://argeo.org/projects/slc/schemas"};                      \r
                        this.setStatus(org.argeo.ria.util.Element.getSingleNodeText(slcExecXml, "slc:status", NSMap));\r