WebKit/chromium/public/WebIDBObjectStore.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 WebIDBObjectStore_h
  27 #define WebIDBObjectStore_h
  28
  29 #include "WebCommon.h"
  30 #include "WebExceptionCode.h"
  31 #include "WebDOMStringList.h"
  32 #include "WebIDBCallbacks.h"
  33 #include "WebIDBTransaction.h"
  34 #include "WebString.h"
  35
  36 namespace WebKit {
  37
  38 class WebIDBKeyRange;
  39 class WebIDBTransaction;
  40
  41 // See comment in WebIDBFactory for a high level overview these classes.
  42 class WebIDBObjectStore {
  43 public:
  44     virtual ~WebIDBObjectStore() { }
  45
  46     virtual WebString name() const
  47     {
  48         WEBKIT_ASSERT_NOT_REACHED();
  49         return WebString();
  50     }
  51     virtual WebString keyPath() const
  52     {
  53         WEBKIT_ASSERT_NOT_REACHED();
  54         return WebString();
  55     }
  56     virtual WebDOMStringList indexNames() const
  57     {
  58         WEBKIT_ASSERT_NOT_REACHED();
  59         return WebDOMStringList();
  60     }
  61
  62     virtual void get(const WebIDBKey&, WebIDBCallbacks*, const WebIDBTransaction&, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
  63     virtual void put(const WebSerializedScriptValue&, const WebIDBKey&, bool addOnly, WebIDBCallbacks*, const WebIDBTransaction&, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
  64     virtual void remove(const WebIDBKey&, WebIDBCallbacks*, const WebIDBTransaction&, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
  65     virtual WebIDBIndex* createIndex(const WebString& name, const WebString& keyPath, bool unique, const WebIDBTransaction&, WebExceptionCode&)
  66     {
  67         WEBKIT_ASSERT_NOT_REACHED();
  68         return 0;
  69     }
  70     // Transfers ownership of the WebIDBIndex to the caller.
  71     virtual WebIDBIndex* index(const WebString& name, WebExceptionCode&)
  72     {
  73         WEBKIT_ASSERT_NOT_REACHED();
  74         return 0;
  75     }
  76     virtual void removeIndex(const WebString& name, const WebIDBTransaction&, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
  77     virtual void openCursor(const WebIDBKeyRange&, unsigned short direction, WebIDBCallbacks*, const WebIDBTransaction&, WebExceptionCode&) { WEBKIT_ASSERT_NOT_REACHED(); }
  78 };
  79
  80 } // namespace WebKit
  81
  82 #endif // WebIDBObjectStore_h