Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / src / data / proxy / Client.js
1 /*
2
3 This file is part of Ext JS 4
4
5 Copyright (c) 2011 Sencha Inc
6
7 Contact:  http://www.sencha.com/contact
8
9 GNU General Public License Usage
10 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.
11
12 If you are unsure which license is appropriate for your use, please contact the sales department at http://www.sencha.com/contact.
13
14 */
15 /**
16  * @author Ed Spencer
17  *
18  * Base class for any client-side storage. Used as a superclass for {@link Ext.data.proxy.Memory Memory} and
19  * {@link Ext.data.proxy.WebStorage Web Storage} proxies. Do not use directly, use one of the subclasses instead.
20  * @private
21  */
22 Ext.define('Ext.data.proxy.Client', {
23     extend: 'Ext.data.proxy.Proxy',
24     alternateClassName: 'Ext.data.ClientProxy',
25
26     /**
27      * Abstract function that must be implemented by each ClientProxy subclass. This should purge all record data
28      * from the client side storage, as well as removing any supporting data (such as lists of record IDs)
29      */
30     clear: function() {
31         //<debug>
32         Ext.Error.raise("The Ext.data.proxy.Client subclass that you are using has not defined a 'clear' function. See src/data/ClientProxy.js for details.");
33         //</debug>
34     }
35 });