Upgrade to ExtJS 3.2.1 - Released 04/27/2010
[extjs.git] / src / data / Store.js
1 /*!
2  * Ext JS Library 3.2.1
3  * Copyright(c) 2006-2010 Ext JS, Inc.
4  * licensing@extjs.com
5  * http://www.extjs.com/license
6  */
7 /**
8  * @class Ext.data.Store
9  * @extends Ext.util.Observable
10  * <p>The Store class encapsulates a client side cache of {@link Ext.data.Record Record}
11  * objects which provide input data for Components such as the {@link Ext.grid.GridPanel GridPanel},
12  * the {@link Ext.form.ComboBox ComboBox}, or the {@link Ext.DataView DataView}.</p>
13  * <p><u>Retrieving Data</u></p>
14  * <p>A Store object may access a data object using:<div class="mdetail-params"><ul>
15  * <li>{@link #proxy configured implementation} of {@link Ext.data.DataProxy DataProxy}</li>
16  * <li>{@link #data} to automatically pass in data</li>
17  * <li>{@link #loadData} to manually pass in data</li>
18  * </ul></div></p>
19  * <p><u>Reading Data</u></p>
20  * <p>A Store object has no inherent knowledge of the format of the data object (it could be
21  * an Array, XML, or JSON). A Store object uses an appropriate {@link #reader configured implementation}
22  * of a {@link Ext.data.DataReader DataReader} to create {@link Ext.data.Record Record} instances from the data
23  * object.</p>
24  * <p><u>Store Types</u></p>
25  * <p>There are several implementations of Store available which are customized for use with
26  * a specific DataReader implementation.  Here is an example using an ArrayStore which implicitly
27  * creates a reader commensurate to an Array data object.</p>
28  * <pre><code>
29 var myStore = new Ext.data.ArrayStore({
30     fields: ['fullname', 'first'],
31     idIndex: 0 // id for each record will be the first element
32 });
33  * </code></pre>
34  * <p>For custom implementations create a basic {@link Ext.data.Store} configured as needed:</p>
35  * <pre><code>
36 // create a {@link Ext.data.Record Record} constructor:
37 var rt = Ext.data.Record.create([
38     {name: 'fullname'},
39     {name: 'first'}
40 ]);
41 var myStore = new Ext.data.Store({
42     // explicitly create reader
43     reader: new Ext.data.ArrayReader(
44         {
45             idIndex: 0  // id for each record will be the first element
46         },
47         rt // recordType
48     )
49 });
50  * </code></pre>
51  * <p>Load some data into store (note the data object is an array which corresponds to the reader):</p>
52  * <pre><code>
53 var myData = [
54     [1, 'Fred Flintstone', 'Fred'],  // note that id for the record is the first element
55     [2, 'Barney Rubble', 'Barney']
56 ];
57 myStore.loadData(myData);
58  * </code></pre>
59  * <p>Records are cached and made available through accessor functions.  An example of adding
60  * a record to the store:</p>
61  * <pre><code>
62 var defaultData = {
63     fullname: 'Full Name',
64     first: 'First Name'
65 };
66 var recId = 100; // provide unique id for the record
67 var r = new myStore.recordType(defaultData, ++recId); // create new record
68 myStore.{@link #insert}(0, r); // insert a new record into the store (also see {@link #add})
69  * </code></pre>
70  * <p><u>Writing Data</u></p>
71  * <p>And <b>new in Ext version 3</b>, use the new {@link Ext.data.DataWriter DataWriter} to create an automated, <a href="http://extjs.com/deploy/dev/examples/writer/writer.html">Writable Store</a>
72  * along with <a href="http://extjs.com/deploy/dev/examples/restful/restful.html">RESTful features.</a>
73  * @constructor
74  * Creates a new Store.
75  * @param {Object} config A config object containing the objects needed for the Store to access data,
76  * and read the data into Records.
77  * @xtype store
78  */
79 Ext.data.Store = Ext.extend(Ext.util.Observable, {
80     /**
81      * @cfg {String} storeId If passed, the id to use to register with the <b>{@link Ext.StoreMgr StoreMgr}</b>.
82      * <p><b>Note</b>: if a (deprecated) <tt>{@link #id}</tt> is specified it will supersede the <tt>storeId</tt>
83      * assignment.</p>
84      */
85     /**
86      * @cfg {String} url If a <tt>{@link #proxy}</tt> is not specified the <tt>url</tt> will be used to
87      * implicitly configure a {@link Ext.data.HttpProxy HttpProxy} if an <tt>url</tt> is specified.
88      * Typically this option, or the <code>{@link #data}</code> option will be specified.
89      */
90     /**
91      * @cfg {Boolean/Object} autoLoad If <tt>{@link #data}</tt> is not specified, and if <tt>autoLoad</tt>
92      * is <tt>true</tt> or an <tt>Object</tt>, this store's {@link #load} method is automatically called
93      * after creation. If the value of <tt>autoLoad</tt> is an <tt>Object</tt>, this <tt>Object</tt> will
94      * be passed to the store's {@link #load} method.
95      */
96     /**
97      * @cfg {Ext.data.DataProxy} proxy The {@link Ext.data.DataProxy DataProxy} object which provides
98      * access to a data object.  See <code>{@link #url}</code>.
99      */
100     /**
101      * @cfg {Array} data An inline data object readable by the <code>{@link #reader}</code>.
102      * Typically this option, or the <code>{@link #url}</code> option will be specified.
103      */
104     /**
105      * @cfg {Ext.data.DataReader} reader The {@link Ext.data.DataReader Reader} object which processes the
106      * data object and returns an Array of {@link Ext.data.Record} objects which are cached keyed by their
107      * <b><tt>{@link Ext.data.Record#id id}</tt></b> property.
108      */
109     /**
110      * @cfg {Ext.data.DataWriter} writer
111      * <p>The {@link Ext.data.DataWriter Writer} object which processes a record object for being written
112      * to the server-side database.</p>
113      * <br><p>When a writer is installed into a Store the {@link #add}, {@link #remove}, and {@link #update}
114      * events on the store are monitored in order to remotely {@link #createRecords create records},
115      * {@link #destroyRecord destroy records}, or {@link #updateRecord update records}.</p>
116      * <br><p>The proxy for this store will relay any {@link #writexception} events to this store.</p>
117      * <br><p>Sample implementation:
118      * <pre><code>
119 var writer = new {@link Ext.data.JsonWriter}({
120     encode: true,
121     writeAllFields: true // write all fields, not just those that changed
122 });
123
124 // Typical Store collecting the Proxy, Reader and Writer together.
125 var store = new Ext.data.Store({
126     storeId: 'user',
127     root: 'records',
128     proxy: proxy,
129     reader: reader,
130     writer: writer,     // <-- plug a DataWriter into the store just as you would a Reader
131     paramsAsHash: true,
132     autoSave: false    // <-- false to delay executing create, update, destroy requests
133                         //     until specifically told to do so.
134 });
135      * </code></pre></p>
136      */
137     writer : undefined,
138     /**
139      * @cfg {Object} baseParams
140      * <p>An object containing properties which are to be sent as parameters
141      * for <i>every</i> HTTP request.</p>
142      * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.</p>
143      * <p><b>Note</b>: <code>baseParams</code> may be superseded by any <code>params</code>
144      * specified in a <code>{@link #load}</code> request, see <code>{@link #load}</code>
145      * for more details.</p>
146      * This property may be modified after creation using the <code>{@link #setBaseParam}</code>
147      * method.
148      * @property
149      */
150     /**
151      * @cfg {Object} sortInfo A config object to specify the sort order in the request of a Store's
152      * {@link #load} operation.  Note that for local sorting, the <tt>direction</tt> property is
153      * case-sensitive. See also {@link #remoteSort} and {@link #paramNames}.
154      * For example:<pre><code>
155 sortInfo: {
156     field: 'fieldName',
157     direction: 'ASC' // or 'DESC' (case sensitive for local sorting)
158 }
159 </code></pre>
160      */
161     /**
162      * @cfg {boolean} remoteSort <tt>true</tt> if sorting is to be handled by requesting the <tt>{@link #proxy Proxy}</tt>
163      * to provide a refreshed version of the data object in sorted order, as opposed to sorting the Record cache
164      * in place (defaults to <tt>false</tt>).
165      * <p>If <tt>remoteSort</tt> is <tt>true</tt>, then clicking on a {@link Ext.grid.Column Grid Column}'s
166      * {@link Ext.grid.Column#header header} causes the current page to be requested from the server appending
167      * the following two parameters to the <b><tt>{@link #load params}</tt></b>:<div class="mdetail-params"><ul>
168      * <li><b><tt>sort</tt></b> : String<p class="sub-desc">The <tt>name</tt> (as specified in the Record's
169      * {@link Ext.data.Field Field definition}) of the field to sort on.</p></li>
170      * <li><b><tt>dir</tt></b> : String<p class="sub-desc">The direction of the sort, 'ASC' or 'DESC' (case-sensitive).</p></li>
171      * </ul></div></p>
172      */
173     remoteSort : false,
174
175     /**
176      * @cfg {Boolean} autoDestroy <tt>true</tt> to destroy the store when the component the store is bound
177      * to is destroyed (defaults to <tt>false</tt>).
178      * <p><b>Note</b>: this should be set to true when using stores that are bound to only 1 component.</p>
179      */
180     autoDestroy : false,
181
182     /**
183      * @cfg {Boolean} pruneModifiedRecords <tt>true</tt> to clear all modified record information each time
184      * the store is loaded or when a record is removed (defaults to <tt>false</tt>). See {@link #getModifiedRecords}
185      * for the accessor method to retrieve the modified records.
186      */
187     pruneModifiedRecords : false,
188
189     /**
190      * Contains the last options object used as the parameter to the {@link #load} method. See {@link #load}
191      * for the details of what this may contain. This may be useful for accessing any params which were used
192      * to load the current Record cache.
193      * @property
194      */
195     lastOptions : null,
196
197     /**
198      * @cfg {Boolean} autoSave
199      * <p>Defaults to <tt>true</tt> causing the store to automatically {@link #save} records to
200      * the server when a record is modified (ie: becomes 'dirty'). Specify <tt>false</tt> to manually call {@link #save}
201      * to send all modifiedRecords to the server.</p>
202      * <br><p><b>Note</b>: each CRUD action will be sent as a separate request.</p>
203      */
204     autoSave : true,
205
206     /**
207      * @cfg {Boolean} batch
208      * <p>Defaults to <tt>true</tt> (unless <code>{@link #restful}:true</code>). Multiple
209      * requests for each CRUD action (CREATE, READ, UPDATE and DESTROY) will be combined
210      * and sent as one transaction. Only applies when <code>{@link #autoSave}</code> is set
211      * to <tt>false</tt>.</p>
212      * <br><p>If Store is RESTful, the DataProxy is also RESTful, and a unique transaction is
213      * generated for each record.</p>
214      */
215     batch : true,
216
217     /**
218      * @cfg {Boolean} restful
219      * Defaults to <tt>false</tt>.  Set to <tt>true</tt> to have the Store and the set
220      * Proxy operate in a RESTful manner. The store will automatically generate GET, POST,
221      * PUT and DELETE requests to the server. The HTTP method used for any given CRUD
222      * action is described in {@link Ext.data.Api#restActions}.  For additional information
223      * see {@link Ext.data.DataProxy#restful}.
224      * <p><b>Note</b>: if <code>{@link #restful}:true</code> <code>batch</code> will
225      * internally be set to <tt>false</tt>.</p>
226      */
227     restful: false,
228
229     /**
230      * @cfg {Object} paramNames
231      * <p>An object containing properties which specify the names of the paging and
232      * sorting parameters passed to remote servers when loading blocks of data. By default, this
233      * object takes the following form:</p><pre><code>
234 {
235     start : 'start',  // The parameter name which specifies the start row
236     limit : 'limit',  // The parameter name which specifies number of rows to return
237     sort : 'sort',    // The parameter name which specifies the column to sort on
238     dir : 'dir'       // The parameter name which specifies the sort direction
239 }
240 </code></pre>
241      * <p>The server must produce the requested data block upon receipt of these parameter names.
242      * If different parameter names are required, this property can be overriden using a configuration
243      * property.</p>
244      * <p>A {@link Ext.PagingToolbar PagingToolbar} bound to this Store uses this property to determine
245      * the parameter names to use in its {@link #load requests}.
246      */
247     paramNames : undefined,
248
249     /**
250      * @cfg {Object} defaultParamNames
251      * Provides the default values for the {@link #paramNames} property. To globally modify the parameters
252      * for all stores, this object should be changed on the store prototype.
253      */
254     defaultParamNames : {
255         start : 'start',
256         limit : 'limit',
257         sort : 'sort',
258         dir : 'dir'
259     },
260
261     /**
262      * @property isDestroyed
263      * @type Boolean
264      * True if the store has been destroyed already. Read only
265      */
266     isDestroyed: false,
267
268     /**
269      * @property hasMultiSort
270      * @type Boolean
271      * True if this store is currently sorted by more than one field/direction combination.
272      */
273     hasMultiSort: false,
274
275     // private
276     batchKey : '_ext_batch_',
277
278     constructor : function(config){
279         this.data = new Ext.util.MixedCollection(false);
280         this.data.getKey = function(o){
281             return o.id;
282         };
283
284
285         // temporary removed-records cache
286         this.removed = [];
287
288         if(config && config.data){
289             this.inlineData = config.data;
290             delete config.data;
291         }
292
293         Ext.apply(this, config);
294
295         /**
296          * See the <code>{@link #baseParams corresponding configuration option}</code>
297          * for a description of this property.
298          * To modify this property see <code>{@link #setBaseParam}</code>.
299          * @property
300          */
301         this.baseParams = Ext.isObject(this.baseParams) ? this.baseParams : {};
302
303         this.paramNames = Ext.applyIf(this.paramNames || {}, this.defaultParamNames);
304
305         if((this.url || this.api) && !this.proxy){
306             this.proxy = new Ext.data.HttpProxy({url: this.url, api: this.api});
307         }
308         // If Store is RESTful, so too is the DataProxy
309         if (this.restful === true && this.proxy) {
310             // When operating RESTfully, a unique transaction is generated for each record.
311             // TODO might want to allow implemention of faux REST where batch is possible using RESTful routes only.
312             this.batch = false;
313             Ext.data.Api.restify(this.proxy);
314         }
315
316         if(this.reader){ // reader passed
317             if(!this.recordType){
318                 this.recordType = this.reader.recordType;
319             }
320             if(this.reader.onMetaChange){
321                 this.reader.onMetaChange = this.reader.onMetaChange.createSequence(this.onMetaChange, this);
322             }
323             if (this.writer) { // writer passed
324                 if (this.writer instanceof(Ext.data.DataWriter) === false) {    // <-- config-object instead of instance.
325                     this.writer = this.buildWriter(this.writer);
326                 }
327                 this.writer.meta = this.reader.meta;
328                 this.pruneModifiedRecords = true;
329             }
330         }
331
332         /**
333          * The {@link Ext.data.Record Record} constructor as supplied to (or created by) the
334          * {@link Ext.data.DataReader Reader}. Read-only.
335          * <p>If the Reader was constructed by passing in an Array of {@link Ext.data.Field} definition objects,
336          * instead of a Record constructor, it will implicitly create a Record constructor from that Array (see
337          * {@link Ext.data.Record}.{@link Ext.data.Record#create create} for additional details).</p>
338          * <p>This property may be used to create new Records of the type held in this Store, for example:</p><pre><code>
339     // create the data store
340     var store = new Ext.data.ArrayStore({
341         autoDestroy: true,
342         fields: [
343            {name: 'company'},
344            {name: 'price', type: 'float'},
345            {name: 'change', type: 'float'},
346            {name: 'pctChange', type: 'float'},
347            {name: 'lastChange', type: 'date', dateFormat: 'n/j h:ia'}
348         ]
349     });
350     store.loadData(myData);
351
352     // create the Grid
353     var grid = new Ext.grid.EditorGridPanel({
354         store: store,
355         colModel: new Ext.grid.ColumnModel({
356             columns: [
357                 {id:'company', header: 'Company', width: 160, dataIndex: 'company'},
358                 {header: 'Price', renderer: 'usMoney', dataIndex: 'price'},
359                 {header: 'Change', renderer: change, dataIndex: 'change'},
360                 {header: '% Change', renderer: pctChange, dataIndex: 'pctChange'},
361                 {header: 'Last Updated', width: 85,
362                     renderer: Ext.util.Format.dateRenderer('m/d/Y'),
363                     dataIndex: 'lastChange'}
364             ],
365             defaults: {
366                 sortable: true,
367                 width: 75
368             }
369         }),
370         autoExpandColumn: 'company', // match the id specified in the column model
371         height:350,
372         width:600,
373         title:'Array Grid',
374         tbar: [{
375             text: 'Add Record',
376             handler : function(){
377                 var defaultData = {
378                     change: 0,
379                     company: 'New Company',
380                     lastChange: (new Date()).clearTime(),
381                     pctChange: 0,
382                     price: 10
383                 };
384                 var recId = 3; // provide unique id
385                 var p = new store.recordType(defaultData, recId); // create new record
386                 grid.stopEditing();
387                 store.{@link #insert}(0, p); // insert a new record into the store (also see {@link #add})
388                 grid.startEditing(0, 0);
389             }
390         }]
391     });
392          * </code></pre>
393          * @property recordType
394          * @type Function
395          */
396
397         if(this.recordType){
398             /**
399              * A {@link Ext.util.MixedCollection MixedCollection} containing the defined {@link Ext.data.Field Field}s
400              * for the {@link Ext.data.Record Records} stored in this Store. Read-only.
401              * @property fields
402              * @type Ext.util.MixedCollection
403              */
404             this.fields = this.recordType.prototype.fields;
405         }
406         this.modified = [];
407
408         this.addEvents(
409             /**
410              * @event datachanged
411              * Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a
412              * widget that is using this Store as a Record cache should refresh its view.
413              * @param {Store} this
414              */
415             'datachanged',
416             /**
417              * @event metachange
418              * Fires when this store's reader provides new metadata (fields). This is currently only supported for JsonReaders.
419              * @param {Store} this
420              * @param {Object} meta The JSON metadata
421              */
422             'metachange',
423             /**
424              * @event add
425              * Fires when Records have been {@link #add}ed to the Store
426              * @param {Store} this
427              * @param {Ext.data.Record[]} records The array of Records added
428              * @param {Number} index The index at which the record(s) were added
429              */
430             'add',
431             /**
432              * @event remove
433              * Fires when a Record has been {@link #remove}d from the Store
434              * @param {Store} this
435              * @param {Ext.data.Record} record The Record that was removed
436              * @param {Number} index The index at which the record was removed
437              */
438             'remove',
439             /**
440              * @event update
441              * Fires when a Record has been updated
442              * @param {Store} this
443              * @param {Ext.data.Record} record The Record that was updated
444              * @param {String} operation The update operation being performed.  Value may be one of:
445              * <pre><code>
446      Ext.data.Record.EDIT
447      Ext.data.Record.REJECT
448      Ext.data.Record.COMMIT
449              * </code></pre>
450              */
451             'update',
452             /**
453              * @event clear
454              * Fires when the data cache has been cleared.
455              * @param {Store} this
456              * @param {Record[]} The records that were cleared.
457              */
458             'clear',
459             /**
460              * @event exception
461              * <p>Fires if an exception occurs in the Proxy during a remote request.
462              * This event is relayed through the corresponding {@link Ext.data.DataProxy}.
463              * See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#exception exception}
464              * for additional details.
465              * @param {misc} misc See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#exception exception}
466              * for description.
467              */
468             'exception',
469             /**
470              * @event beforeload
471              * Fires before a request is made for a new data object.  If the beforeload handler returns
472              * <tt>false</tt> the {@link #load} action will be canceled.
473              * @param {Store} this
474              * @param {Object} options The loading options that were specified (see {@link #load} for details)
475              */
476             'beforeload',
477             /**
478              * @event load
479              * Fires after a new set of Records has been loaded.
480              * @param {Store} this
481              * @param {Ext.data.Record[]} records The Records that were loaded
482              * @param {Object} options The loading options that were specified (see {@link #load} for details)
483              */
484             'load',
485             /**
486              * @event loadexception
487              * <p>This event is <b>deprecated</b> in favor of the catch-all <b><code>{@link #exception}</code></b>
488              * event instead.</p>
489              * <p>This event is relayed through the corresponding {@link Ext.data.DataProxy}.
490              * See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#loadexception loadexception}
491              * for additional details.
492              * @param {misc} misc See {@link Ext.data.DataProxy}.{@link Ext.data.DataProxy#loadexception loadexception}
493              * for description.
494              */
495             'loadexception',
496             /**
497              * @event beforewrite
498              * @param {Ext.data.Store} store
499              * @param {String} action [Ext.data.Api.actions.create|update|destroy]
500              * @param {Record/Record[]} rs The Record(s) being written.
501              * @param {Object} options The loading options that were specified. Edit <code>options.params</code> to add Http parameters to the request.  (see {@link #save} for details)
502              * @param {Object} arg The callback's arg object passed to the {@link #request} function
503              */
504             'beforewrite',
505             /**
506              * @event write
507              * Fires if the server returns 200 after an Ext.data.Api.actions CRUD action.
508              * Success of the action is determined in the <code>result['successProperty']</code>property (<b>NOTE</b> for RESTful stores,
509              * a simple 20x response is sufficient for the actions "destroy" and "update".  The "create" action should should return 200 along with a database pk).
510              * @param {Ext.data.Store} store
511              * @param {String} action [Ext.data.Api.actions.create|update|destroy]
512              * @param {Object} result The 'data' picked-out out of the response for convenience.
513              * @param {Ext.Direct.Transaction} res
514              * @param {Record/Record[]} rs Store's records, the subject(s) of the write-action
515              */
516             'write',
517             /**
518              * @event beforesave
519              * Fires before a save action is called. A save encompasses destroying records, updating records and creating records.
520              * @param {Ext.data.Store} store
521              * @param {Object} data An object containing the data that is to be saved. The object will contain a key for each appropriate action,
522              * with an array of records for each action.
523              */
524             'beforesave',
525             /**
526              * @event save
527              * Fires after a save is completed. A save encompasses destroying records, updating records and creating records.
528              * @param {Ext.data.Store} store
529              * @param {Number} batch The identifier for the batch that was saved.
530              * @param {Object} data An object containing the data that is to be saved. The object will contain a key for each appropriate action,
531              * with an array of records for each action.
532              */
533             'save'
534
535         );
536
537         if(this.proxy){
538             // TODO remove deprecated loadexception with ext-3.0.1
539             this.relayEvents(this.proxy,  ['loadexception', 'exception']);
540         }
541         // With a writer set for the Store, we want to listen to add/remove events to remotely create/destroy records.
542         if (this.writer) {
543             this.on({
544                 scope: this,
545                 add: this.createRecords,
546                 remove: this.destroyRecord,
547                 update: this.updateRecord,
548                 clear: this.onClear
549             });
550         }
551
552         this.sortToggle = {};
553         if(this.sortField){
554             this.setDefaultSort(this.sortField, this.sortDir);
555         }else if(this.sortInfo){
556             this.setDefaultSort(this.sortInfo.field, this.sortInfo.direction);
557         }
558
559         Ext.data.Store.superclass.constructor.call(this);
560
561         if(this.id){
562             this.storeId = this.id;
563             delete this.id;
564         }
565         if(this.storeId){
566             Ext.StoreMgr.register(this);
567         }
568         if(this.inlineData){
569             this.loadData(this.inlineData);
570             delete this.inlineData;
571         }else if(this.autoLoad){
572             this.load.defer(10, this, [
573                 typeof this.autoLoad == 'object' ?
574                     this.autoLoad : undefined]);
575         }
576         // used internally to uniquely identify a batch
577         this.batchCounter = 0;
578         this.batches = {};
579     },
580
581     /**
582      * builds a DataWriter instance when Store constructor is provided with a writer config-object instead of an instace.
583      * @param {Object} config Writer configuration
584      * @return {Ext.data.DataWriter}
585      * @private
586      */
587     buildWriter : function(config) {
588         var klass = undefined,
589             type = (config.format || 'json').toLowerCase();
590         switch (type) {
591             case 'json':
592                 klass = Ext.data.JsonWriter;
593                 break;
594             case 'xml':
595                 klass = Ext.data.XmlWriter;
596                 break;
597             default:
598                 klass = Ext.data.JsonWriter;
599         }
600         return new klass(config);
601     },
602
603     /**
604      * Destroys the store.
605      */
606     destroy : function(){
607         if(!this.isDestroyed){
608             if(this.storeId){
609                 Ext.StoreMgr.unregister(this);
610             }
611             this.clearData();
612             this.data = null;
613             Ext.destroy(this.proxy);
614             this.reader = this.writer = null;
615             this.purgeListeners();
616             this.isDestroyed = true;
617         }
618     },
619
620     /**
621      * Add Records to the Store and fires the {@link #add} event.  To add Records
622      * to the store from a remote source use <code>{@link #load}({add:true})</code>.
623      * See also <code>{@link #recordType}</code> and <code>{@link #insert}</code>.
624      * @param {Ext.data.Record[]} records An Array of Ext.data.Record objects
625      * to add to the cache. See {@link #recordType}.
626      */
627     add : function(records){
628         records = [].concat(records);
629         if(records.length < 1){
630             return;
631         }
632         for(var i = 0, len = records.length; i < len; i++){
633             records[i].join(this);
634         }
635         var index = this.data.length;
636         this.data.addAll(records);
637         if(this.snapshot){
638             this.snapshot.addAll(records);
639         }
640         this.fireEvent('add', this, records, index);
641     },
642
643     /**
644      * (Local sort only) Inserts the passed Record into the Store at the index where it
645      * should go based on the current sort information.
646      * @param {Ext.data.Record} record
647      */
648     addSorted : function(record){
649         var index = this.findInsertIndex(record);
650         this.insert(index, record);
651     },
652
653     /**
654      * Remove Records from the Store and fires the {@link #remove} event.
655      * @param {Ext.data.Record/Ext.data.Record[]} record The record object or array of records to remove from the cache.
656      */
657     remove : function(record){
658         if(Ext.isArray(record)){
659             Ext.each(record, function(r){
660                 this.remove(r);
661             }, this);
662             return;
663         }
664         var index = this.data.indexOf(record);
665         if(index > -1){
666             record.join(null);
667             this.data.removeAt(index);
668         }
669         if(this.pruneModifiedRecords){
670             this.modified.remove(record);
671         }
672         if(this.snapshot){
673             this.snapshot.remove(record);
674         }
675         if(index > -1){
676             this.fireEvent('remove', this, record, index);
677         }
678     },
679
680     /**
681      * Remove a Record from the Store at the specified index. Fires the {@link #remove} event.
682      * @param {Number} index The index of the record to remove.
683      */
684     removeAt : function(index){
685         this.remove(this.getAt(index));
686     },
687
688     /**
689      * Remove all Records from the Store and fires the {@link #clear} event.
690      * @param {Boolean} silent [false] Defaults to <tt>false</tt>.  Set <tt>true</tt> to not fire clear event.
691      */
692     removeAll : function(silent){
693         var items = [];
694         this.each(function(rec){
695             items.push(rec);
696         });
697         this.clearData();
698         if(this.snapshot){
699             this.snapshot.clear();
700         }
701         if(this.pruneModifiedRecords){
702             this.modified = [];
703         }
704         if (silent !== true) {  // <-- prevents write-actions when we just want to clear a store.
705             this.fireEvent('clear', this, items);
706         }
707     },
708
709     // private
710     onClear: function(store, records){
711         Ext.each(records, function(rec, index){
712             this.destroyRecord(this, rec, index);
713         }, this);
714     },
715
716     /**
717      * Inserts Records into the Store at the given index and fires the {@link #add} event.
718      * See also <code>{@link #add}</code> and <code>{@link #addSorted}</code>.
719      * @param {Number} index The start index at which to insert the passed Records.
720      * @param {Ext.data.Record[]} records An Array of Ext.data.Record objects to add to the cache.
721      */
722     insert : function(index, records){
723         records = [].concat(records);
724         for(var i = 0, len = records.length; i < len; i++){
725             this.data.insert(index, records[i]);
726             records[i].join(this);
727         }
728         if(this.snapshot){
729             this.snapshot.addAll(records);
730         }
731         this.fireEvent('add', this, records, index);
732     },
733
734     /**
735      * Get the index within the cache of the passed Record.
736      * @param {Ext.data.Record} record The Ext.data.Record object to find.
737      * @return {Number} The index of the passed Record. Returns -1 if not found.
738      */
739     indexOf : function(record){
740         return this.data.indexOf(record);
741     },
742
743     /**
744      * Get the index within the cache of the Record with the passed id.
745      * @param {String} id The id of the Record to find.
746      * @return {Number} The index of the Record. Returns -1 if not found.
747      */
748     indexOfId : function(id){
749         return this.data.indexOfKey(id);
750     },
751
752     /**
753      * Get the Record with the specified id.
754      * @param {String} id The id of the Record to find.
755      * @return {Ext.data.Record} The Record with the passed id. Returns undefined if not found.
756      */
757     getById : function(id){
758         return (this.snapshot || this.data).key(id);
759     },
760
761     /**
762      * Get the Record at the specified index.
763      * @param {Number} index The index of the Record to find.
764      * @return {Ext.data.Record} The Record at the passed index. Returns undefined if not found.
765      */
766     getAt : function(index){
767         return this.data.itemAt(index);
768     },
769
770     /**
771      * Returns a range of Records between specified indices.
772      * @param {Number} startIndex (optional) The starting index (defaults to 0)
773      * @param {Number} endIndex (optional) The ending index (defaults to the last Record in the Store)
774      * @return {Ext.data.Record[]} An array of Records
775      */
776     getRange : function(start, end){
777         return this.data.getRange(start, end);
778     },
779
780     // private
781     storeOptions : function(o){
782         o = Ext.apply({}, o);
783         delete o.callback;
784         delete o.scope;
785         this.lastOptions = o;
786     },
787
788     // private
789     clearData: function(){
790         this.data.each(function(rec) {
791             rec.join(null);
792         });
793         this.data.clear();
794     },
795
796     /**
797      * <p>Loads the Record cache from the configured <tt>{@link #proxy}</tt> using the configured <tt>{@link #reader}</tt>.</p>
798      * <br><p>Notes:</p><div class="mdetail-params"><ul>
799      * <li><b><u>Important</u></b>: loading is asynchronous! This call will return before the new data has been
800      * loaded. To perform any post-processing where information from the load call is required, specify
801      * the <tt>callback</tt> function to be called, or use a {@link Ext.util.Observable#listeners a 'load' event handler}.</li>
802      * <li>If using {@link Ext.PagingToolbar remote paging}, the first load call must specify the <tt>start</tt> and <tt>limit</tt>
803      * properties in the <code>options.params</code> property to establish the initial position within the
804      * dataset, and the number of Records to cache on each read from the Proxy.</li>
805      * <li>If using {@link #remoteSort remote sorting}, the configured <code>{@link #sortInfo}</code>
806      * will be automatically included with the posted parameters according to the specified
807      * <code>{@link #paramNames}</code>.</li>
808      * </ul></div>
809      * @param {Object} options An object containing properties which control loading options:<ul>
810      * <li><b><tt>params</tt></b> :Object<div class="sub-desc"><p>An object containing properties to pass as HTTP
811      * parameters to a remote data source. <b>Note</b>: <code>params</code> will override any
812      * <code>{@link #baseParams}</code> of the same name.</p>
813      * <p>Parameters are encoded as standard HTTP parameters using {@link Ext#urlEncode}.</p></div></li>
814      * <li><b>callback</b> : Function<div class="sub-desc"><p>A function to be called after the Records
815      * have been loaded. The callback is called after the load event is fired, and is passed the following arguments:<ul>
816      * <li>r : Ext.data.Record[] An Array of Records loaded.</li>
817      * <li>options : Options object from the load call.</li>
818      * <li>success : Boolean success indicator.</li></ul></p></div></li>
819      * <li><b>scope</b> : Object<div class="sub-desc"><p>Scope with which to call the callback (defaults
820      * to the Store object)</p></div></li>
821      * <li><b>add</b> : Boolean<div class="sub-desc"><p>Indicator to append loaded records rather than
822      * replace the current cache.  <b>Note</b>: see note for <tt>{@link #loadData}</tt></p></div></li>
823      * </ul>
824      * @return {Boolean} If the <i>developer</i> provided <tt>{@link #beforeload}</tt> event handler returns
825      * <tt>false</tt>, the load call will abort and will return <tt>false</tt>; otherwise will return <tt>true</tt>.
826      */
827     load : function(options) {
828         options = Ext.apply({}, options);
829         this.storeOptions(options);
830         if(this.sortInfo && this.remoteSort){
831             var pn = this.paramNames;
832             options.params = Ext.apply({}, options.params);
833             options.params[pn.sort] = this.sortInfo.field;
834             options.params[pn.dir] = this.sortInfo.direction;
835         }
836         try {
837             return this.execute('read', null, options); // <-- null represents rs.  No rs for load actions.
838         } catch(e) {
839             this.handleException(e);
840             return false;
841         }
842     },
843
844     /**
845      * updateRecord  Should not be used directly.  This method will be called automatically if a Writer is set.
846      * Listens to 'update' event.
847      * @param {Object} store
848      * @param {Object} record
849      * @param {Object} action
850      * @private
851      */
852     updateRecord : function(store, record, action) {
853         if (action == Ext.data.Record.EDIT && this.autoSave === true && (!record.phantom || (record.phantom && record.isValid()))) {
854             this.save();
855         }
856     },
857
858     /**
859      * Should not be used directly.  Store#add will call this automatically if a Writer is set
860      * @param {Object} store
861      * @param {Object} rs
862      * @param {Object} index
863      * @private
864      */
865     createRecords : function(store, rs, index) {
866         for (var i = 0, len = rs.length; i < len; i++) {
867             if (rs[i].phantom && rs[i].isValid()) {
868                 rs[i].markDirty();  // <-- Mark new records dirty
869                 this.modified.push(rs[i]);  // <-- add to modified
870             }
871         }
872         if (this.autoSave === true) {
873             this.save();
874         }
875     },
876
877     /**
878      * Destroys a Record.  Should not be used directly.  It's called by Store#remove if a Writer is set.
879      * @param {Store} store this
880      * @param {Ext.data.Record} record
881      * @param {Number} index
882      * @private
883      */
884     destroyRecord : function(store, record, index) {
885         if (this.modified.indexOf(record) != -1) {  // <-- handled already if @cfg pruneModifiedRecords == true
886             this.modified.remove(record);
887         }
888         if (!record.phantom) {
889             this.removed.push(record);
890
891             // since the record has already been removed from the store but the server request has not yet been executed,
892             // must keep track of the last known index this record existed.  If a server error occurs, the record can be
893             // put back into the store.  @see Store#createCallback where the record is returned when response status === false
894             record.lastIndex = index;
895
896             if (this.autoSave === true) {
897                 this.save();
898             }
899         }
900     },
901
902     /**
903      * This method should generally not be used directly.  This method is called internally
904      * by {@link #load}, or if a Writer is set will be called automatically when {@link #add},
905      * {@link #remove}, or {@link #update} events fire.
906      * @param {String} action Action name ('read', 'create', 'update', or 'destroy')
907      * @param {Record/Record[]} rs
908      * @param {Object} options
909      * @throws Error
910      * @private
911      */
912     execute : function(action, rs, options, /* private */ batch) {
913         // blow up if action not Ext.data.CREATE, READ, UPDATE, DESTROY
914         if (!Ext.data.Api.isAction(action)) {
915             throw new Ext.data.Api.Error('execute', action);
916         }
917         // make sure options has a fresh, new params hash
918         options = Ext.applyIf(options||{}, {
919             params: {}
920         });
921         if(batch !== undefined){
922             this.addToBatch(batch);
923         }
924         // have to separate before-events since load has a different signature than create,destroy and save events since load does not
925         // include the rs (record resultset) parameter.  Capture return values from the beforeaction into doRequest flag.
926         var doRequest = true;
927
928         if (action === 'read') {
929             doRequest = this.fireEvent('beforeload', this, options);
930             Ext.applyIf(options.params, this.baseParams);
931         }
932         else {
933             // if Writer is configured as listful, force single-record rs to be [{}] instead of {}
934             // TODO Move listful rendering into DataWriter where the @cfg is defined.  Should be easy now.
935             if (this.writer.listful === true && this.restful !== true) {
936                 rs = (Ext.isArray(rs)) ? rs : [rs];
937             }
938             // if rs has just a single record, shift it off so that Writer writes data as '{}' rather than '[{}]'
939             else if (Ext.isArray(rs) && rs.length == 1) {
940                 rs = rs.shift();
941             }
942             // Write the action to options.params
943             if ((doRequest = this.fireEvent('beforewrite', this, action, rs, options)) !== false) {
944                 this.writer.apply(options.params, this.baseParams, action, rs);
945             }
946         }
947         if (doRequest !== false) {
948             // Send request to proxy.
949             if (this.writer && this.proxy.url && !this.proxy.restful && !Ext.data.Api.hasUniqueUrl(this.proxy, action)) {
950                 options.params.xaction = action;    // <-- really old, probaby unecessary.
951             }
952             // Note:  Up until this point we've been dealing with 'action' as a key from Ext.data.Api.actions.
953             // We'll flip it now and send the value into DataProxy#request, since it's the value which maps to
954             // the user's configured DataProxy#api
955             // TODO Refactor all Proxies to accept an instance of Ext.data.Request (not yet defined) instead of this looooooong list
956             // of params.  This method is an artifact from Ext2.
957             this.proxy.request(Ext.data.Api.actions[action], rs, options.params, this.reader, this.createCallback(action, rs, batch), this, options);
958         }
959         return doRequest;
960     },
961
962     /**
963      * Saves all pending changes to the store.  If the commensurate Ext.data.Api.actions action is not configured, then
964      * the configured <code>{@link #url}</code> will be used.
965      * <pre>
966      * change            url
967      * ---------------   --------------------
968      * removed records   Ext.data.Api.actions.destroy
969      * phantom records   Ext.data.Api.actions.create
970      * {@link #getModifiedRecords modified records}  Ext.data.Api.actions.update
971      * </pre>
972      * @TODO:  Create extensions of Error class and send associated Record with thrown exceptions.
973      * e.g.:  Ext.data.DataReader.Error or Ext.data.Error or Ext.data.DataProxy.Error, etc.
974      * @return {Number} batch Returns a number to uniquely identify the "batch" of saves occurring. -1 will be returned
975      * if there are no items to save or the save was cancelled.
976      */
977     save : function() {
978         if (!this.writer) {
979             throw new Ext.data.Store.Error('writer-undefined');
980         }
981
982         var queue = [],
983             len,
984             trans,
985             batch,
986             data = {};
987         // DESTROY:  First check for removed records.  Records in this.removed are guaranteed non-phantoms.  @see Store#remove
988         if(this.removed.length){
989             queue.push(['destroy', this.removed]);
990         }
991
992         // Check for modified records. Use a copy so Store#rejectChanges will work if server returns error.
993         var rs = [].concat(this.getModifiedRecords());
994         if(rs.length){
995             // CREATE:  Next check for phantoms within rs.  splice-off and execute create.
996             var phantoms = [];
997             for(var i = rs.length-1; i >= 0; i--){
998                 if(rs[i].phantom === true){
999                     var rec = rs.splice(i, 1).shift();
1000                     if(rec.isValid()){
1001                         phantoms.push(rec);
1002                     }
1003                 }else if(!rs[i].isValid()){ // <-- while we're here, splice-off any !isValid real records
1004                     rs.splice(i,1);
1005                 }
1006             }
1007             // If we have valid phantoms, create them...
1008             if(phantoms.length){
1009                 queue.push(['create', phantoms]);
1010             }
1011
1012             // UPDATE:  And finally, if we're still here after splicing-off phantoms and !isValid real records, update the rest...
1013             if(rs.length){
1014                 queue.push(['update', rs]);
1015             }
1016         }
1017         len = queue.length;
1018         if(len){
1019             batch = ++this.batchCounter;
1020             for(var i = 0; i < len; ++i){
1021                 trans = queue[i];
1022                 data[trans[0]] = trans[1];
1023             }
1024             if(this.fireEvent('beforesave', this, data) !== false){
1025                 for(var i = 0; i < len; ++i){
1026                     trans = queue[i];
1027                     this.doTransaction(trans[0], trans[1], batch);
1028                 }
1029                 return batch;
1030             }
1031         }
1032         return -1;
1033     },
1034
1035     // private.  Simply wraps call to Store#execute in try/catch.  Defers to Store#handleException on error.  Loops if batch: false
1036     doTransaction : function(action, rs, batch) {
1037         function transaction(records) {
1038             try{
1039                 this.execute(action, records, undefined, batch);
1040             }catch (e){
1041                 this.handleException(e);
1042             }
1043         }
1044         if(this.batch === false){
1045             for(var i = 0, len = rs.length; i < len; i++){
1046                 transaction.call(this, rs[i]);
1047             }
1048         }else{
1049             transaction.call(this, rs);
1050         }
1051     },
1052
1053     // private
1054     addToBatch : function(batch){
1055         var b = this.batches,
1056             key = this.batchKey + batch,
1057             o = b[key];
1058
1059         if(!o){
1060             b[key] = o = {
1061                 id: batch,
1062                 count: 0,
1063                 data: {}
1064             };
1065         }
1066         ++o.count;
1067     },
1068
1069     removeFromBatch : function(batch, action, data){
1070         var b = this.batches,
1071             key = this.batchKey + batch,
1072             o = b[key],
1073             data,
1074             arr;
1075
1076
1077         if(o){
1078             arr = o.data[action] || [];
1079             o.data[action] = arr.concat(data);
1080             if(o.count === 1){
1081                 data = o.data;
1082                 delete b[key];
1083                 this.fireEvent('save', this, batch, data);
1084             }else{
1085                 --o.count;
1086             }
1087         }
1088     },
1089
1090     // @private callback-handler for remote CRUD actions
1091     // Do not override -- override loadRecords, onCreateRecords, onDestroyRecords and onUpdateRecords instead.
1092     createCallback : function(action, rs, batch) {
1093         var actions = Ext.data.Api.actions;
1094         return (action == 'read') ? this.loadRecords : function(data, response, success) {
1095             // calls: onCreateRecords | onUpdateRecords | onDestroyRecords
1096             this['on' + Ext.util.Format.capitalize(action) + 'Records'](success, rs, [].concat(data));
1097             // If success === false here, exception will have been called in DataProxy
1098             if (success === true) {
1099                 this.fireEvent('write', this, action, data, response, rs);
1100             }
1101             this.removeFromBatch(batch, action, data);
1102         };
1103     },
1104
1105     // Clears records from modified array after an exception event.
1106     // NOTE:  records are left marked dirty.  Do we want to commit them even though they were not updated/realized?
1107     // TODO remove this method?
1108     clearModified : function(rs) {
1109         if (Ext.isArray(rs)) {
1110             for (var n=rs.length-1;n>=0;n--) {
1111                 this.modified.splice(this.modified.indexOf(rs[n]), 1);
1112             }
1113         } else {
1114             this.modified.splice(this.modified.indexOf(rs), 1);
1115         }
1116     },
1117
1118     // remap record ids in MixedCollection after records have been realized.  @see Store#onCreateRecords, @see DataReader#realize
1119     reMap : function(record) {
1120         if (Ext.isArray(record)) {
1121             for (var i = 0, len = record.length; i < len; i++) {
1122                 this.reMap(record[i]);
1123             }
1124         } else {
1125             delete this.data.map[record._phid];
1126             this.data.map[record.id] = record;
1127             var index = this.data.keys.indexOf(record._phid);
1128             this.data.keys.splice(index, 1, record.id);
1129             delete record._phid;
1130         }
1131     },
1132
1133     // @protected onCreateRecord proxy callback for create action
1134     onCreateRecords : function(success, rs, data) {
1135         if (success === true) {
1136             try {
1137                 this.reader.realize(rs, data);
1138                 this.reMap(rs);
1139             }
1140             catch (e) {
1141                 this.handleException(e);
1142                 if (Ext.isArray(rs)) {
1143                     // Recurse to run back into the try {}.  DataReader#realize splices-off the rs until empty.
1144                     this.onCreateRecords(success, rs, data);
1145                 }
1146             }
1147         }
1148     },
1149
1150     // @protected, onUpdateRecords proxy callback for update action
1151     onUpdateRecords : function(success, rs, data) {
1152         if (success === true) {
1153             try {
1154                 this.reader.update(rs, data);
1155             } catch (e) {
1156                 this.handleException(e);
1157                 if (Ext.isArray(rs)) {
1158                     // Recurse to run back into the try {}.  DataReader#update splices-off the rs until empty.
1159                     this.onUpdateRecords(success, rs, data);
1160                 }
1161             }
1162         }
1163     },
1164
1165     // @protected onDestroyRecords proxy callback for destroy action
1166     onDestroyRecords : function(success, rs, data) {
1167         // splice each rec out of this.removed
1168         rs = (rs instanceof Ext.data.Record) ? [rs] : [].concat(rs);
1169         for (var i=0,len=rs.length;i<len;i++) {
1170             this.removed.splice(this.removed.indexOf(rs[i]), 1);
1171         }
1172         if (success === false) {
1173             // put records back into store if remote destroy fails.
1174             // @TODO: Might want to let developer decide.
1175             for (i=rs.length-1;i>=0;i--) {
1176                 this.insert(rs[i].lastIndex, rs[i]);    // <-- lastIndex set in Store#destroyRecord
1177             }
1178         }
1179     },
1180
1181     // protected handleException.  Possibly temporary until Ext framework has an exception-handler.
1182     handleException : function(e) {
1183         // @see core/Error.js
1184         Ext.handleError(e);
1185     },
1186
1187     /**
1188      * <p>Reloads the Record cache from the configured Proxy using the configured
1189      * {@link Ext.data.Reader Reader} and the options from the last load operation
1190      * performed.</p>
1191      * <p><b>Note</b>: see the Important note in {@link #load}.</p>
1192      * @param {Object} options <p>(optional) An <tt>Object</tt> containing
1193      * {@link #load loading options} which may override the {@link #lastOptions options}
1194      * used in the last {@link #load} operation. See {@link #load} for details
1195      * (defaults to <tt>null</tt>, in which case the {@link #lastOptions} are
1196      * used).</p>
1197      * <br><p>To add new params to the existing params:</p><pre><code>
1198 lastOptions = myStore.lastOptions;
1199 Ext.apply(lastOptions.params, {
1200     myNewParam: true
1201 });
1202 myStore.reload(lastOptions);
1203      * </code></pre>
1204      */
1205     reload : function(options){
1206         this.load(Ext.applyIf(options||{}, this.lastOptions));
1207     },
1208
1209     // private
1210     // Called as a callback by the Reader during a load operation.
1211     loadRecords : function(o, options, success){
1212         if (this.isDestroyed === true) {
1213             return;
1214         }
1215         if(!o || success === false){
1216             if(success !== false){
1217                 this.fireEvent('load', this, [], options);
1218             }
1219             if(options.callback){
1220                 options.callback.call(options.scope || this, [], options, false, o);
1221             }
1222             return;
1223         }
1224         var r = o.records, t = o.totalRecords || r.length;
1225         if(!options || options.add !== true){
1226             if(this.pruneModifiedRecords){
1227                 this.modified = [];
1228             }
1229             for(var i = 0, len = r.length; i < len; i++){
1230                 r[i].join(this);
1231             }
1232             if(this.snapshot){
1233                 this.data = this.snapshot;
1234                 delete this.snapshot;
1235             }
1236             this.clearData();
1237             this.data.addAll(r);
1238             this.totalLength = t;
1239             this.applySort();
1240             this.fireEvent('datachanged', this);
1241         }else{
1242             this.totalLength = Math.max(t, this.data.length+r.length);
1243             this.add(r);
1244         }
1245         this.fireEvent('load', this, r, options);
1246         if(options.callback){
1247             options.callback.call(options.scope || this, r, options, true);
1248         }
1249     },
1250
1251     /**
1252      * Loads data from a passed data block and fires the {@link #load} event. A {@link Ext.data.Reader Reader}
1253      * which understands the format of the data must have been configured in the constructor.
1254      * @param {Object} data The data block from which to read the Records.  The format of the data expected
1255      * is dependent on the type of {@link Ext.data.Reader Reader} that is configured and should correspond to
1256      * that {@link Ext.data.Reader Reader}'s <tt>{@link Ext.data.Reader#readRecords}</tt> parameter.
1257      * @param {Boolean} append (Optional) <tt>true</tt> to append the new Records rather the default to replace
1258      * the existing cache.
1259      * <b>Note</b>: that Records in a Store are keyed by their {@link Ext.data.Record#id id}, so added Records
1260      * with ids which are already present in the Store will <i>replace</i> existing Records. Only Records with
1261      * new, unique ids will be added.
1262      */
1263     loadData : function(o, append){
1264         var r = this.reader.readRecords(o);
1265         this.loadRecords(r, {add: append}, true);
1266     },
1267
1268     /**
1269      * Gets the number of cached records.
1270      * <p>If using paging, this may not be the total size of the dataset. If the data object
1271      * used by the Reader contains the dataset size, then the {@link #getTotalCount} function returns
1272      * the dataset size.  <b>Note</b>: see the Important note in {@link #load}.</p>
1273      * @return {Number} The number of Records in the Store's cache.
1274      */
1275     getCount : function(){
1276         return this.data.length || 0;
1277     },
1278
1279     /**
1280      * Gets the total number of records in the dataset as returned by the server.
1281      * <p>If using paging, for this to be accurate, the data object used by the {@link #reader Reader}
1282      * must contain the dataset size. For remote data sources, the value for this property
1283      * (<tt>totalProperty</tt> for {@link Ext.data.JsonReader JsonReader},
1284      * <tt>totalRecords</tt> for {@link Ext.data.XmlReader XmlReader}) shall be returned by a query on the server.
1285      * <b>Note</b>: see the Important note in {@link #load}.</p>
1286      * @return {Number} The number of Records as specified in the data object passed to the Reader
1287      * by the Proxy.
1288      * <p><b>Note</b>: this value is not updated when changing the contents of the Store locally.</p>
1289      */
1290     getTotalCount : function(){
1291         return this.totalLength || 0;
1292     },
1293
1294     /**
1295      * Returns an object describing the current sort state of this Store.
1296      * @return {Object} The sort state of the Store. An object with two properties:<ul>
1297      * <li><b>field : String<p class="sub-desc">The name of the field by which the Records are sorted.</p></li>
1298      * <li><b>direction : String<p class="sub-desc">The sort order, 'ASC' or 'DESC' (case-sensitive).</p></li>
1299      * </ul>
1300      * See <tt>{@link #sortInfo}</tt> for additional details.
1301      */
1302     getSortState : function(){
1303         return this.sortInfo;
1304     },
1305
1306     /**
1307      * @private
1308      * Invokes sortData if we have sortInfo to sort on and are not sorting remotely
1309      */
1310     applySort : function(){
1311         if ((this.sortInfo || this.multiSortInfo) && !this.remoteSort) {
1312             this.sortData();
1313         }
1314     },
1315
1316     /**
1317      * @private
1318      * Performs the actual sorting of data. This checks to see if we currently have a multi sort or not. It applies
1319      * each sorter field/direction pair in turn by building an OR'ed master sorting function and running it against
1320      * the full dataset
1321      */
1322     sortData : function() {
1323         var sortInfo  = this.hasMultiSort ? this.multiSortInfo : this.sortInfo,
1324             direction = sortInfo.direction || "ASC",
1325             sorters   = sortInfo.sorters,
1326             sortFns   = [];
1327
1328         //if we just have a single sorter, pretend it's the first in an array
1329         if (!this.hasMultiSort) {
1330             sorters = [{direction: direction, field: sortInfo.field}];
1331         }
1332
1333         //create a sorter function for each sorter field/direction combo
1334         for (var i=0, j = sorters.length; i < j; i++) {
1335             sortFns.push(this.createSortFunction(sorters[i].field, sorters[i].direction));
1336         }
1337         
1338         if (sortFns.length == 0) {
1339             return;
1340         }
1341
1342         //the direction modifier is multiplied with the result of the sorting functions to provide overall sort direction
1343         //(as opposed to direction per field)
1344         var directionModifier = direction.toUpperCase() == "DESC" ? -1 : 1;
1345
1346         //create a function which ORs each sorter together to enable multi-sort
1347         var fn = function(r1, r2) {
1348           var result = sortFns[0].call(this, r1, r2);
1349
1350           //if we have more than one sorter, OR any additional sorter functions together
1351           if (sortFns.length > 1) {
1352               for (var i=1, j = sortFns.length; i < j; i++) {
1353                   result = result || sortFns[i].call(this, r1, r2);
1354               }
1355           }
1356
1357           return directionModifier * result;
1358         };
1359
1360         //sort the data
1361         this.data.sort(direction, fn);
1362         if (this.snapshot && this.snapshot != this.data) {
1363             this.snapshot.sort(direction, fn);
1364         }
1365     },
1366
1367     /**
1368      * @private
1369      * Creates and returns a function which sorts an array by the given field and direction
1370      * @param {String} field The field to create the sorter for
1371      * @param {String} direction The direction to sort by (defaults to "ASC")
1372      * @return {Function} A function which sorts by the field/direction combination provided
1373      */
1374     createSortFunction: function(field, direction) {
1375         direction = direction || "ASC";
1376         var directionModifier = direction.toUpperCase() == "DESC" ? -1 : 1;
1377
1378         var sortType = this.fields.get(field).sortType;
1379
1380         //create a comparison function. Takes 2 records, returns 1 if record 1 is greater,
1381         //-1 if record 2 is greater or 0 if they are equal
1382         return function(r1, r2) {
1383             var v1 = sortType(r1.data[field]),
1384                 v2 = sortType(r2.data[field]);
1385
1386             return directionModifier * (v1 > v2 ? 1 : (v1 < v2 ? -1 : 0));
1387         };
1388     },
1389
1390     /**
1391      * Sets the default sort column and order to be used by the next {@link #load} operation.
1392      * @param {String} fieldName The name of the field to sort by.
1393      * @param {String} dir (optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to <tt>'ASC'</tt>)
1394      */
1395     setDefaultSort : function(field, dir) {
1396         dir = dir ? dir.toUpperCase() : 'ASC';
1397         this.sortInfo = {field: field, direction: dir};
1398         this.sortToggle[field] = dir;
1399     },
1400
1401     /**
1402      * Sort the Records.
1403      * If remote sorting is used, the sort is performed on the server, and the cache is reloaded. If local
1404      * sorting is used, the cache is sorted internally. See also {@link #remoteSort} and {@link #paramNames}.
1405      * This function accepts two call signatures - pass in a field name as the first argument to sort on a single
1406      * field, or pass in an array of sort configuration objects to sort by multiple fields.
1407      * Single sort example:
1408      * store.sort('name', 'ASC');
1409      * Multi sort example:
1410      * store.sort([
1411      *   {
1412      *     field    : 'name',
1413      *     direction: 'ASC'
1414      *   },
1415      *   {
1416      *     field    : 'salary',
1417      *     direction: 'DESC'
1418      *   }
1419      * ], 'ASC');
1420      * In this second form, the sort configs are applied in order, with later sorters sorting within earlier sorters' results.
1421      * For example, if two records with the same name are present they will also be sorted by salary if given the sort configs
1422      * above. Any number of sort configs can be added.
1423      * @param {String/Array} fieldName The name of the field to sort by, or an array of ordered sort configs
1424      * @param {String} dir (optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to <tt>'ASC'</tt>)
1425      */
1426     sort : function(fieldName, dir) {
1427         if (Ext.isArray(arguments[0])) {
1428             return this.multiSort.call(this, fieldName, dir);
1429         } else {
1430             return this.singleSort(fieldName, dir);
1431         }
1432     },
1433
1434     /**
1435      * Sorts the store contents by a single field and direction. This is called internally by {@link sort} and would
1436      * not usually be called manually
1437      * @param {String} fieldName The name of the field to sort by.
1438      * @param {String} dir (optional) The sort order, 'ASC' or 'DESC' (case-sensitive, defaults to <tt>'ASC'</tt>)
1439      */
1440     singleSort: function(fieldName, dir) {
1441         var field = this.fields.get(fieldName);
1442         if (!field) return false;
1443
1444         var name       = field.name,
1445             sortInfo   = this.sortInfo || null,
1446             sortToggle = this.sortToggle ? this.sortToggle[name] : null;
1447
1448         if (!dir) {
1449             if (sortInfo && sortInfo.field == name) { // toggle sort dir
1450                 dir = (this.sortToggle[name] || 'ASC').toggle('ASC', 'DESC');
1451             } else {
1452                 dir = field.sortDir;
1453             }
1454         }
1455
1456         this.sortToggle[name] = dir;
1457         this.sortInfo = {field: name, direction: dir};
1458         this.hasMultiSort = false;
1459
1460         if (this.remoteSort) {
1461             if (!this.load(this.lastOptions)) {
1462                 if (sortToggle) {
1463                     this.sortToggle[name] = sortToggle;
1464                 }
1465                 if (sortInfo) {
1466                     this.sortInfo = sortInfo;
1467                 }
1468             }
1469         } else {
1470             this.applySort();
1471             this.fireEvent('datachanged', this);
1472         }
1473     },
1474
1475     /**
1476      * Sorts the contents of this store by multiple field/direction sorters. This is called internally by {@link sort}
1477      * and would not usually be called manually.
1478      * Multi sorting only currently applies to local datasets - multiple sort data is not currently sent to a proxy
1479      * if remoteSort is used.
1480      * @param {Array} sorters Array of sorter objects (field and direction)
1481      * @param {String} direction Overall direction to sort the ordered results by (defaults to "ASC")
1482      */
1483     multiSort: function(sorters, direction) {
1484         this.hasMultiSort = true;
1485         direction = direction || "ASC";
1486
1487         //toggle sort direction
1488         if (this.multiSortInfo && direction == this.multiSortInfo.direction) {
1489             direction = direction.toggle("ASC", "DESC");
1490         }
1491
1492         /**
1493          * @property multiSortInfo
1494          * @type Object
1495          * Object containing overall sort direction and an ordered array of sorter configs used when sorting on multiple fields
1496          */
1497         this.multiSortInfo = {
1498             sorters  : sorters,
1499             direction: direction
1500         };
1501         
1502         if (this.remoteSort) {
1503             this.singleSort(sorters[0].field, sorters[0].direction);
1504
1505         } else {
1506             this.applySort();
1507             this.fireEvent('datachanged', this);
1508         }
1509     },
1510
1511     /**
1512      * Calls the specified function for each of the {@link Ext.data.Record Records} in the cache.
1513      * @param {Function} fn The function to call. The {@link Ext.data.Record Record} is passed as the first parameter.
1514      * Returning <tt>false</tt> aborts and exits the iteration.
1515      * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed.
1516      * Defaults to the current {@link Ext.data.Record Record} in the iteration.
1517      */
1518     each : function(fn, scope){
1519         this.data.each(fn, scope);
1520     },
1521
1522     /**
1523      * Gets all {@link Ext.data.Record records} modified since the last commit.  Modified records are
1524      * persisted across load operations (e.g., during paging). <b>Note</b>: deleted records are not
1525      * included.  See also <tt>{@link #pruneModifiedRecords}</tt> and
1526      * {@link Ext.data.Record}<tt>{@link Ext.data.Record#markDirty markDirty}.</tt>.
1527      * @return {Ext.data.Record[]} An array of {@link Ext.data.Record Records} containing outstanding
1528      * modifications.  To obtain modified fields within a modified record see
1529      *{@link Ext.data.Record}<tt>{@link Ext.data.Record#modified modified}.</tt>.
1530      */
1531     getModifiedRecords : function(){
1532         return this.modified;
1533     },
1534
1535     /**
1536      * Sums the value of <tt>property</tt> for each {@link Ext.data.Record record} between <tt>start</tt>
1537      * and <tt>end</tt> and returns the result.
1538      * @param {String} property A field in each record
1539      * @param {Number} start (optional) The record index to start at (defaults to <tt>0</tt>)
1540      * @param {Number} end (optional) The last record index to include (defaults to length - 1)
1541      * @return {Number} The sum
1542      */
1543     sum : function(property, start, end){
1544         var rs = this.data.items, v = 0;
1545         start = start || 0;
1546         end = (end || end === 0) ? end : rs.length-1;
1547
1548         for(var i = start; i <= end; i++){
1549             v += (rs[i].data[property] || 0);
1550         }
1551         return v;
1552     },
1553
1554     /**
1555      * @private
1556      * Returns a filter function used to test a the given property's value. Defers most of the work to
1557      * Ext.util.MixedCollection's createValueMatcher function
1558      * @param {String} property The property to create the filter function for
1559      * @param {String/RegExp} value The string/regex to compare the property value to
1560      * @param {Boolean} anyMatch True if we don't care if the filter value is not the full value (defaults to false)
1561      * @param {Boolean} caseSensitive True to create a case-sensitive regex (defaults to false)
1562      * @param {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true.
1563      */
1564     createFilterFn : function(property, value, anyMatch, caseSensitive, exactMatch){
1565         if(Ext.isEmpty(value, false)){
1566             return false;
1567         }
1568         value = this.data.createValueMatcher(value, anyMatch, caseSensitive, exactMatch);
1569         return function(r) {
1570             return value.test(r.data[property]);
1571         };
1572     },
1573
1574     /**
1575      * @private
1576      * Given an array of filter functions (each with optional scope), constructs and returns a single function that returns
1577      * the result of all of the filters ANDed together
1578      * @param {Array} filters The array of filter objects (each object should contain an 'fn' and optional scope)
1579      * @return {Function} The multiple filter function
1580      */
1581     createMultipleFilterFn: function(filters) {
1582         return function(record) {
1583             var isMatch = true;
1584
1585             for (var i=0, j = filters.length; i < j; i++) {
1586                 var filter = filters[i],
1587                     fn     = filter.fn,
1588                     scope  = filter.scope;
1589
1590                 isMatch = isMatch && fn.call(scope, record);
1591             }
1592
1593             return isMatch;
1594         };
1595     },
1596
1597     /**
1598      * Filter the {@link Ext.data.Record records} by a specified property. Alternatively, pass an array of filter
1599      * options to filter by more than one property.
1600      * Single filter example:
1601      * store.filter('name', 'Ed', true, true); //finds all records containing the substring 'Ed'
1602      * Multiple filter example:
1603      * <pre><code>
1604      * store.filter([
1605      *   {
1606      *     property     : 'name',
1607      *     value        : 'Ed',
1608      *     anyMatch     : true, //optional, defaults to true
1609      *     caseSensitive: true  //optional, defaults to true
1610      *   },
1611      *
1612      *   //filter functions can also be passed
1613      *   {
1614      *     fn   : function(record) {
1615      *       return record.get('age') == 24
1616      *     },
1617      *     scope: this
1618      *   }
1619      * ]);
1620      * </code></pre>
1621      * @param {String|Array} field A field on your records, or an array containing multiple filter options
1622      * @param {String/RegExp} value Either a string that the field should begin with, or a RegExp to test
1623      * against the field.
1624      * @param {Boolean} anyMatch (optional) <tt>true</tt> to match any part not just the beginning
1625      * @param {Boolean} caseSensitive (optional) <tt>true</tt> for case sensitive comparison
1626      * @param {Boolean} exactMatch True to force exact match (^ and $ characters added to the regex). Defaults to false. Ignored if anyMatch is true.
1627      */
1628     filter : function(property, value, anyMatch, caseSensitive, exactMatch){
1629         //we can accept an array of filter objects, or a single filter object - normalize them here
1630         if (Ext.isObject(property)) {
1631             property = [property];
1632         }
1633
1634         if (Ext.isArray(property)) {
1635             var filters = [];
1636
1637             //normalize the filters passed into an array of filter functions
1638             for (var i=0, j = property.length; i < j; i++) {
1639                 var filter = property[i],
1640                     func   = filter.fn,
1641                     scope  = filter.scope || this;
1642
1643                 //if we weren't given a filter function, construct one now
1644                 if (!Ext.isFunction(func)) {
1645                     func = this.createFilterFn(filter.property, filter.value, filter.anyMatch, filter.caseSensitive, filter.exactMatch);
1646                 }
1647
1648                 filters.push({fn: func, scope: scope});
1649             }
1650
1651             var fn = this.createMultipleFilterFn(filters);
1652         } else {
1653             //classic single property filter
1654             var fn = this.createFilterFn(property, value, anyMatch, caseSensitive, exactMatch);
1655         }
1656
1657         return fn ? this.filterBy(fn) : this.clearFilter();
1658     },
1659
1660     /**
1661      * Filter by a function. The specified function will be called for each
1662      * Record in this Store. If the function returns <tt>true</tt> the Record is included,
1663      * otherwise it is filtered out.
1664      * @param {Function} fn The function to be called. It will be passed the following parameters:<ul>
1665      * <li><b>record</b> : Ext.data.Record<p class="sub-desc">The {@link Ext.data.Record record}
1666      * to test for filtering. Access field values using {@link Ext.data.Record#get}.</p></li>
1667      * <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
1668      * </ul>
1669      * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.
1670      */
1671     filterBy : function(fn, scope){
1672         this.snapshot = this.snapshot || this.data;
1673         this.data = this.queryBy(fn, scope||this);
1674         this.fireEvent('datachanged', this);
1675     },
1676
1677     /**
1678      * Revert to a view of the Record cache with no filtering applied.
1679      * @param {Boolean} suppressEvent If <tt>true</tt> the filter is cleared silently without firing the
1680      * {@link #datachanged} event.
1681      */
1682     clearFilter : function(suppressEvent){
1683         if(this.isFiltered()){
1684             this.data = this.snapshot;
1685             delete this.snapshot;
1686             if(suppressEvent !== true){
1687                 this.fireEvent('datachanged', this);
1688             }
1689         }
1690     },
1691
1692     /**
1693      * Returns true if this store is currently filtered
1694      * @return {Boolean}
1695      */
1696     isFiltered : function(){
1697         return !!this.snapshot && this.snapshot != this.data;
1698     },
1699
1700     /**
1701      * Query the records by a specified property.
1702      * @param {String} field A field on your records
1703      * @param {String/RegExp} value Either a string that the field
1704      * should begin with, or a RegExp to test against the field.
1705      * @param {Boolean} anyMatch (optional) True to match any part not just the beginning
1706      * @param {Boolean} caseSensitive (optional) True for case sensitive comparison
1707      * @return {MixedCollection} Returns an Ext.util.MixedCollection of the matched records
1708      */
1709     query : function(property, value, anyMatch, caseSensitive){
1710         var fn = this.createFilterFn(property, value, anyMatch, caseSensitive);
1711         return fn ? this.queryBy(fn) : this.data.clone();
1712     },
1713
1714     /**
1715      * Query the cached records in this Store using a filtering function. The specified function
1716      * will be called with each record in this Store. If the function returns <tt>true</tt> the record is
1717      * included in the results.
1718      * @param {Function} fn The function to be called. It will be passed the following parameters:<ul>
1719      * <li><b>record</b> : Ext.data.Record<p class="sub-desc">The {@link Ext.data.Record record}
1720      * to test for filtering. Access field values using {@link Ext.data.Record#get}.</p></li>
1721      * <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
1722      * </ul>
1723      * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.
1724      * @return {MixedCollection} Returns an Ext.util.MixedCollection of the matched records
1725      **/
1726     queryBy : function(fn, scope){
1727         var data = this.snapshot || this.data;
1728         return data.filterBy(fn, scope||this);
1729     },
1730
1731     /**
1732      * Finds the index of the first matching Record in this store by a specific field value.
1733      * @param {String} fieldName The name of the Record field to test.
1734      * @param {String/RegExp} value Either a string that the field value
1735      * should begin with, or a RegExp to test against the field.
1736      * @param {Number} startIndex (optional) The index to start searching at
1737      * @param {Boolean} anyMatch (optional) True to match any part of the string, not just the beginning
1738      * @param {Boolean} caseSensitive (optional) True for case sensitive comparison
1739      * @return {Number} The matched index or -1
1740      */
1741     find : function(property, value, start, anyMatch, caseSensitive){
1742         var fn = this.createFilterFn(property, value, anyMatch, caseSensitive);
1743         return fn ? this.data.findIndexBy(fn, null, start) : -1;
1744     },
1745
1746     /**
1747      * Finds the index of the first matching Record in this store by a specific field value.
1748      * @param {String} fieldName The name of the Record field to test.
1749      * @param {Mixed} value The value to match the field against.
1750      * @param {Number} startIndex (optional) The index to start searching at
1751      * @return {Number} The matched index or -1
1752      */
1753     findExact: function(property, value, start){
1754         return this.data.findIndexBy(function(rec){
1755             return rec.get(property) === value;
1756         }, this, start);
1757     },
1758
1759     /**
1760      * Find the index of the first matching Record in this Store by a function.
1761      * If the function returns <tt>true</tt> it is considered a match.
1762      * @param {Function} fn The function to be called. It will be passed the following parameters:<ul>
1763      * <li><b>record</b> : Ext.data.Record<p class="sub-desc">The {@link Ext.data.Record record}
1764      * to test for filtering. Access field values using {@link Ext.data.Record#get}.</p></li>
1765      * <li><b>id</b> : Object<p class="sub-desc">The ID of the Record passed.</p></li>
1766      * </ul>
1767      * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to this Store.
1768      * @param {Number} startIndex (optional) The index to start searching at
1769      * @return {Number} The matched index or -1
1770      */
1771     findBy : function(fn, scope, start){
1772         return this.data.findIndexBy(fn, scope, start);
1773     },
1774
1775     /**
1776      * Collects unique values for a particular dataIndex from this store.
1777      * @param {String} dataIndex The property to collect
1778      * @param {Boolean} allowNull (optional) Pass true to allow null, undefined or empty string values
1779      * @param {Boolean} bypassFilter (optional) Pass true to collect from all records, even ones which are filtered
1780      * @return {Array} An array of the unique values
1781      **/
1782     collect : function(dataIndex, allowNull, bypassFilter){
1783         var d = (bypassFilter === true && this.snapshot) ?
1784                 this.snapshot.items : this.data.items;
1785         var v, sv, r = [], l = {};
1786         for(var i = 0, len = d.length; i < len; i++){
1787             v = d[i].data[dataIndex];
1788             sv = String(v);
1789             if((allowNull || !Ext.isEmpty(v)) && !l[sv]){
1790                 l[sv] = true;
1791                 r[r.length] = v;
1792             }
1793         }
1794         return r;
1795     },
1796
1797     // private
1798     afterEdit : function(record){
1799         if(this.modified.indexOf(record) == -1){
1800             this.modified.push(record);
1801         }
1802         this.fireEvent('update', this, record, Ext.data.Record.EDIT);
1803     },
1804
1805     // private
1806     afterReject : function(record){
1807         this.modified.remove(record);
1808         this.fireEvent('update', this, record, Ext.data.Record.REJECT);
1809     },
1810
1811     // private
1812     afterCommit : function(record){
1813         this.modified.remove(record);
1814         this.fireEvent('update', this, record, Ext.data.Record.COMMIT);
1815     },
1816
1817     /**
1818      * Commit all Records with {@link #getModifiedRecords outstanding changes}. To handle updates for changes,
1819      * subscribe to the Store's {@link #update update event}, and perform updating when the third parameter is
1820      * Ext.data.Record.COMMIT.
1821      */
1822     commitChanges : function(){
1823         var m = this.modified.slice(0);
1824         this.modified = [];
1825         for(var i = 0, len = m.length; i < len; i++){
1826             m[i].commit();
1827         }
1828     },
1829
1830     /**
1831      * {@link Ext.data.Record#reject Reject} outstanding changes on all {@link #getModifiedRecords modified records}.
1832      */
1833     rejectChanges : function(){
1834         var m = this.modified.slice(0);
1835         this.modified = [];
1836         for(var i = 0, len = m.length; i < len; i++){
1837             m[i].reject();
1838         }
1839         var m = this.removed.slice(0).reverse();
1840         this.removed = [];
1841         for(var i = 0, len = m.length; i < len; i++){
1842             this.insert(m[i].lastIndex||0, m[i]);
1843             m[i].reject();
1844         }
1845     },
1846
1847     // private
1848     onMetaChange : function(meta){
1849         this.recordType = this.reader.recordType;
1850         this.fields = this.recordType.prototype.fields;
1851         delete this.snapshot;
1852         if(this.reader.meta.sortInfo){
1853             this.sortInfo = this.reader.meta.sortInfo;
1854         }else if(this.sortInfo  && !this.fields.get(this.sortInfo.field)){
1855             delete this.sortInfo;
1856         }
1857         if(this.writer){
1858             this.writer.meta = this.reader.meta;
1859         }
1860         this.modified = [];
1861         this.fireEvent('metachange', this, this.reader.meta);
1862     },
1863
1864     // private
1865     findInsertIndex : function(record){
1866         this.suspendEvents();
1867         var data = this.data.clone();
1868         this.data.add(record);
1869         this.applySort();
1870         var index = this.data.indexOf(record);
1871         this.data = data;
1872         this.resumeEvents();
1873         return index;
1874     },
1875
1876     /**
1877      * Set the value for a property name in this store's {@link #baseParams}.  Usage:</p><pre><code>
1878 myStore.setBaseParam('foo', {bar:3});
1879 </code></pre>
1880      * @param {String} name Name of the property to assign
1881      * @param {Mixed} value Value to assign the <tt>name</tt>d property
1882      **/
1883     setBaseParam : function (name, value){
1884         this.baseParams = this.baseParams || {};
1885         this.baseParams[name] = value;
1886     }
1887 });
1888
1889 Ext.reg('store', Ext.data.Store);
1890
1891 /**
1892  * @class Ext.data.Store.Error
1893  * @extends Ext.Error
1894  * Store Error extension.
1895  * @param {String} name
1896  */
1897 Ext.data.Store.Error = Ext.extend(Ext.Error, {
1898     name: 'Ext.data.Store'
1899 });
1900 Ext.apply(Ext.data.Store.Error.prototype, {
1901     lang: {
1902         'writer-undefined' : 'Attempted to execute a write-action without a DataWriter installed.'
1903     }
1904 });