Author: hqm
Date: 2008-03-20 12:41:09 -0700 (Thu, 20 Mar 2008)
New Revision: 8334
Modified:
openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataProvider.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataRequest.lzs
openlaszlo/trunk/WEB-INF/lps/lfc/data/LzHTTPDataProvider.lzs
Log:
Change 20080320-hqm-4 by [EMAIL PROTECTED] on 2008-03-20 15:40:37 EDT
in /Users/hqm/openlaszlo/trunk4
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: update doc comments for LzDataProvider
New Features:
Bugs Fixed:
Technical Reviewer: liorio
QA Reviewer: (pending)
Doc Reviewer: (pending)
Documentation:
Release Notes:
Details:
Tests:
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataProvider.lzs
===================================================================
(Binary files differ)
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataRequest.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataRequest.lzs 2008-03-20
19:38:43 UTC (rev 8333)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzDataRequest.lzs 2008-03-20
19:41:09 UTC (rev 8334)
@@ -16,6 +16,7 @@
* </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
*/
@@ -26,7 +27,7 @@
* @modifiers override
*/
static var tagname = 'datarequest';
-/** @access private */
+ /** @access private */
static var attributes = new LzInheritedHash(LzNode.attributes);
/* Status value constants */
@@ -37,12 +38,22 @@
var requestor = null;
+ /** An object which holds the protocol-specific source to load data from
+ @type Object
+ */
var src = null;
+ /** The timeout in milliseconds
+ @type Number
+ */
var timeout = Infinity;
+ /** The status, one of 'success', 'timeout', 'error', or 'ready'
+ @type String
+ */
var status = null;
+ /** Raw data returned by request */
var rawdata = null;
- // Used by dataprovider to record error messages
+ /** Used by dataprovider to record error messages */
var error = null;
/** @lzxtype event */
Modified: openlaszlo/trunk/WEB-INF/lps/lfc/data/LzHTTPDataProvider.lzs
===================================================================
--- openlaszlo/trunk/WEB-INF/lps/lfc/data/LzHTTPDataProvider.lzs
2008-03-20 19:38:43 UTC (rev 8333)
+++ openlaszlo/trunk/WEB-INF/lps/lfc/data/LzHTTPDataProvider.lzs
2008-03-20 19:41:09 UTC (rev 8334)
@@ -13,8 +13,17 @@
* <p>
* <class>LzHTTPDataProvider</class> implements the DataProvider interface,
to support HTTP data requests.
* </p>
+ * <p>
+ * Requests are submitted using the <method>doRequest</method>, passing a
request
+ * object of type <class>LzHTTPDataRequest</class>. And instance of
<class>LzHTTPDataProvider</class> is the default
+ * data provider for the runtime, and is what is used by
<class>LzDataset</class> to load data.
+ * </p>
+ * <p>
+ * <event>onstatus</event>: Sent to a datarequest to update the status of the
request.</p>
+ *
* @shortdesc DataProvider which implements HTTP request transport
* @lzxname httpdataprovider
+ *
*/
@@ -290,6 +299,7 @@
* <p>
* <class>LzHTTPDataRequest</class> implements the DataProvider interface, to
support HTTP data requests.
* </p>
+ *
* @shortdesc A class to represent HTTP data requests.
* @lzxname httpdatarequest
*/
@@ -303,23 +313,49 @@
var multirequest = false;
var queuerequests = false;
+ /** An LzParams object which holds query key-value pairs.
+ @type LzParam
+ */
var queryparams = null; // : LzParam object
+ /** An LzParams object which holds HTTP request headers as key-value pairs.
+ @type LzParam
+ */
var requestheaders = null; // : LzParam object
+ /** Flag to say whether proxied server should return with HTTP response
metadata added.
+ @type Boolean
+ */
var getresponsheaders = false;
- var responseheaders = null; // : LzParam object, returned by dataprovider
+ /** An LzParams object which holds HTTP response headers
+ @type LzParam
+ */
+ var responseheaders = null;
+ /** Flag to say whether data is cacheable at the server
+ @type Boolean
+ */
var cacheable = false;
+ /** Flag to say whether data is cacheable at the client (browser)
+ @type Boolean
+ */
var clientcacheable = null;
+ /** Flag to say whether whitespace should be trimmed from text element
data in returned XML data
+ @type Boolean
+ */
var trimwhitespace = false;
+ /** Flag to say whether namespace prefixes on element and attribute names
is preserved in XML data
+ @type Boolean
+ */
var nsprefix = false;
/** The LZX DOM element containing the loaded data */
var xmldata = null;
- // time it took to load
+ /** Time taken by load, in milliseconds
+ @type Number
+ */
var loadtime = 0;
var secure = false;
@@ -327,6 +363,7 @@
// private, pointer to our lzhttploader
+ /** @access private */
var loader = null;
}
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
