Upgrade to ExtJS 4.0.2 - Released 06/09/2011

[extjs.git] / src / data / Request.js

diff --git a/src/data/Request.js b/src/data/Request.js
index 6c37b2a..c4f0317 100644 (file)
--- a/src/data/Request.js
+++ b/src/data/Request.js
@@ -1,41 +1,53 @@
-/*!
- * Ext JS Library 3.3.1
- * Copyright(c) 2006-2010 Sencha Inc.
- * licensing@sencha.com
- * http://www.sencha.com/license
- */
+/*
+
+This file is part of Ext JS 4
+
+Copyright (c) 2011 Sencha Inc
+
+Contact:  http://www.sencha.com/contact
+
+GNU General Public License Usage
+This file may be used under the terms of the GNU General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE included in the packaging of this file.  Please review the following information to ensure the GNU General Public License version 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html.
+
+If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact.
+
+*/
 /**
+ * @author Ed Spencer
  * @class Ext.data.Request
- * A simple Request class used internally to the data package to provide more generalized remote-requests
- * to a DataProxy.
- * TODO Not yet implemented.  Implement in Ext.data.Store#execute
+ * @extends Object
+ * 
+ * <p>Simple class that represents a Request that will be made by any {@link Ext.data.proxy.Server} subclass.
+ * All this class does is standardize the representation of a Request as used by any ServerProxy subclass,
+ * it does not contain any actual logic or perform the request itself.</p>
+ * 
  */
-Ext.data.Request = function(params) {
-    Ext.apply(this, params);
-};
-Ext.data.Request.prototype = {
-    /**
-     * @cfg {String} action
-     */
-    action : undefined,
+Ext.define('Ext.data.Request', {
     /**
-     * @cfg {Ext.data.Record[]/Ext.data.Record} rs The Store recordset associated with the request.
+     * @cfg {String} action The name of the action this Request represents. Usually one of 'create', 'read', 'update' or 'destroy'
      */
-    rs : undefined,
+    action: undefined,
+    
     /**
-     * @cfg {Object} params HTTP request params
+     * @cfg {Object} params HTTP request params. The Proxy and its Writer have access to and can modify this object.
      */
     params: undefined,
+    
     /**
-     * @cfg {Function} callback The function to call when request is complete
+     * @cfg {String} method The HTTP method to use on this Request (defaults to 'GET'). Should be one of 'GET', 'POST', 'PUT' or 'DELETE'
      */
-    callback : Ext.emptyFn,
+    method: 'GET',
+    
     /**
-     * @cfg {Object} scope The scope of the callback funtion
+     * @cfg {String} url The url to access on this Request
      */
-    scope : undefined,
+    url: undefined,
+
     /**
-     * @cfg {Ext.data.DataReader} reader The DataReader instance which will parse the received response
+     * Creates the Request object.
+     * @param {Object} config (optional) Config object.
      */
-    reader : undefined
-};
+    constructor: function(config) {
+        Ext.apply(this, config);
+    }
+});