Unreviewed, rolling out r251040.
[WebKit-https.git] / Source / WebCore / Modules / indexeddb / IDBIndex.idl
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 // NOTE: This type is specified as 'any' in the IndexedDB specification, but is always
27 // constrained to this union.
28 typedef (DOMString or sequence<DOMString>) IDBKeyPath;
29
30 [
31     Conditional=INDEXED_DATABASE,
32     GenerateIsReachable=Impl,
33     JSCustomMarkFunction,
34     SkipVTableValidation,
35 ] interface IDBIndex {
36     attribute DOMString name;
37     readonly attribute IDBObjectStore objectStore;
38     readonly attribute IDBKeyPath? keyPath;
39     readonly attribute boolean multiEntry;
40     readonly attribute boolean unique;
41
42     [CallWith=ExecState, MayThrowException] IDBRequest openCursor(optional IDBKeyRange? range = null, optional IDBCursorDirection direction = "next");
43     [CallWith=ExecState, MayThrowException] IDBRequest openCursor(any key, optional IDBCursorDirection direction = "next");
44
45     [CallWith=ExecState, MayThrowException] IDBRequest openKeyCursor(optional IDBKeyRange? range = null, optional IDBCursorDirection direction = "next");
46     [CallWith=ExecState, MayThrowException] IDBRequest openKeyCursor(any key, optional IDBCursorDirection direction = "next");
47
48     [CallWith=ExecState, MayThrowException] IDBRequest get(IDBKeyRange? key);
49     [CallWith=ExecState, MayThrowException] IDBRequest get(any key);
50     [CallWith=ExecState, MayThrowException] IDBRequest getKey(IDBKeyRange? key);
51     [CallWith=ExecState, MayThrowException] IDBRequest getKey(any key);
52     [CallWith=ExecState, MayThrowException] IDBRequest getAll(optional IDBKeyRange? range = null, optional [EnforceRange] unsigned long count);
53     [CallWith=ExecState, MayThrowException] IDBRequest getAll(any key, optional [EnforceRange] unsigned long count);
54     [CallWith=ExecState, MayThrowException] IDBRequest getAllKeys(optional IDBKeyRange? range = null, optional [EnforceRange] unsigned long count);
55     [CallWith=ExecState, MayThrowException] IDBRequest getAllKeys(any key, optional [EnforceRange] unsigned long count);
56     [CallWith=ExecState, MayThrowException] IDBRequest count(optional IDBKeyRange? range = null);
57     [CallWith=ExecState, MayThrowException] IDBRequest count(any key);
58 };