2010-11-29 Jeremy Orlow <jorlow@chromium.org>
[WebKit-https.git] / WebKit / chromium / public / WebIDBDatabase.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef WebIDBDatabase_h
27 #define WebIDBDatabase_h
28
29 #include "WebCommon.h"
30 #include "WebDOMStringList.h"
31 #include "WebExceptionCode.h"
32
33 namespace WebKit {
34
35 class WebFrame;
36 class WebIDBCallbacks;
37 class WebIDBObjectStore;
38 class WebIDBTransaction;
39
40 // See comment in WebIDBFactory for a high level overview of these classes.
41 class WebIDBDatabase {
42 public:
43     virtual ~WebIDBDatabase() { }
44
45     virtual WebString name() const
46     {
47         WEBKIT_ASSERT_NOT_REACHED();
48         return WebString();
49     }
50     virtual WebString version() const
51     {
52         WEBKIT_ASSERT_NOT_REACHED();
53         return WebString();
54     }
55     virtual WebDOMStringList objectStoreNames() const
56     {
57         WEBKIT_ASSERT_NOT_REACHED();
58         return WebDOMStringList();
59     }
60     virtual WebIDBObjectStore* createObjectStore(const WebString& name, const WebString& keyPath, bool autoIncrement, const WebIDBTransaction&, WebExceptionCode&)
61     { 
62         WEBKIT_ASSERT_NOT_REACHED();
63         return 0;
64     }
65     virtual void deleteObjectStore(const WebString& name, const WebIDBTransaction& transaction, WebExceptionCode& ec) { WEBKIT_ASSERT_NOT_REACHED(); }
66     virtual void setVersion(const WebString& version, WebIDBCallbacks* callbacks, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
67     // Transfers ownership of the WebIDBTransaction to the caller.
68     virtual WebIDBTransaction* transaction(const WebDOMStringList& names, unsigned short mode, unsigned long timeout, WebExceptionCode&)
69     {
70         WEBKIT_ASSERT_NOT_REACHED();
71         return 0;
72     }
73     virtual void close() { WEBKIT_ASSERT_NOT_REACHED(); }
74
75 protected:
76     WebIDBDatabase() { }
77 };
78
79 } // namespace WebKit
80
81 #endif // WebIDBDatabase_h