[Laszlo-checkins] r8520 - openlaszlo/trunk/WEB-INF/lps/lfc/data

[lou@openlaszlo.org]

Author: lou
Date: 2008-04-02 08:54:52 -0700 (Wed, 02 Apr 2008)
New Revision: 8520

Modified:
   openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataRequest.lzs
Log:
Change 20080402-lou-J by lou at loumac.local on 2008-04-02 11:43:03 AST
    in /Users/lou/src/svn/openlaszlo/trunk
    for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: fix LzDataRequest reference page problems

New Features:

Bugs Fixed: LPP-5596 (partial)

Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: (pending)

Details: added information from the http://wiki.openlaszlo.org/Dataprovider
DataProvider wiki (this information is also in the Data Provider chapter of
the dguide.).

The only remaining problem is in the Class Attributes table: the Category
for ERROR, READY, SUCESS, and TIMEOUT are all "unknown".

Tests: visual verify



Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataRequest.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataRequest.lzs	2008-04-02 15:53:27 UTC (rev 8519)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataRequest.lzs	2008-04-02 15:54:52 UTC (rev 8520)
@@ -10,17 +10,12 @@
   */
 
 /**
-  * <p>
   * <class>LzDataRequest</class> is an abstract class that can be extended to create new kinds 
   * of data requests, which are passed to a <class>DataProvider</class> when making a request.
-  * </p>
-  * <event>onstatus</event>: Sent as data or other conditions occur during the execution of this request.
   *
-  *
   * @shortdesc An abstract class to represent data requests.
   * @lzxname datarequest
   */
-
 class LzDataRequest extends LzNode {
 
     /** @access private
@@ -31,15 +26,32 @@
     static var attributes = new LzInheritedHash(LzNode.attributes);
     
     /* Status value constants */
+    /**
+    * @type String
+    * @lzxdefault "success"
+    */
     static var SUCCESS = 'success';
+    /**
+    * @type String
+    * @lzxdefault "timeout"
+    */
     static var TIMEOUT = 'timeout';
+    /**
+    * @type String
+    * @lzxdefault "error"
+    */
     static var ERROR   = 'error';
+    /**
+    * @type String
+    * @lzxdefault "ready"
+    */
     static var READY   = 'ready';
 
-
+    /** An optional property that's the object using the DataRequest to pass into the dataprovider's doRequest method.
+    * @type Object
     var requestor = null; 
     /** An object which holds the protocol-specific source to load data from
-    @type Object
+    * @type Object
     */
     var src       = null; 
     /** The timeout in milliseconds
@@ -50,15 +62,25 @@
      @type String
     */
     var status    = null; 
-    /** Raw data returned by request */
+    /** Raw data returned by request 
+    * @type String
+    */
     var rawdata   = null; 
 
-    /**  Used by dataprovider to record error messages */
+    /**  Used by dataprovider to record error messages 
+    * @type String
+    */
     var error = null; 
     
-    /** @lzxtype event */
+    /** Sent as data or other conditions occur during the execution of this request.
+    * @lzxtype event 
+    */
     var onstatus = LzDeclaredEvent;
-
+    
+    /** 
+    * The object using the DataRequest to pass into the dataprovider's doRequest method.
+    * @param Object requestor: The object using the DataRequest to pass into the dataprovider's doRequest method.
+    */
     function LzDataRequest (requestor) { 
         super(requestor);
         this.requestor = requestor;