Home | History | Annotate | Download | only in indexeddb 
      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 [
     27 ] interface IDBIndex {
     28     readonly attribute DOMString name;
     29     readonly attribute IDBObjectStore objectStore;
     30     [ImplementedAs=keyPathAny] readonly attribute IDBAny keyPath;
     31     readonly attribute boolean unique;
     32     readonly attribute boolean multiEntry;
     33 
     34     [CallWith=ScriptExecutionContext, RaisesException] IDBRequest openCursor([Default=Undefined] optional IDBKeyRange? range, [Default=NullString] optional DOMString direction);
     35     [CallWith=ScriptExecutionContext, RaisesException] IDBRequest openCursor(any key, [Default=NullString] optional DOMString direction);
     36 
     37     [CallWith=ScriptExecutionContext, RaisesException] IDBRequest openKeyCursor([Default=Undefined] optional IDBKeyRange? range, [Default=NullString] optional DOMString  direction);
     38     [CallWith=ScriptExecutionContext, RaisesException] IDBRequest openKeyCursor(any key, [Default=NullString] optional DOMString direction);
     39 
     40     [CallWith=ScriptExecutionContext, RaisesException] IDBRequest get(IDBKeyRange? key);
     41     [CallWith=ScriptExecutionContext, RaisesException] IDBRequest get(any key);
     42 
     43     [CallWith=ScriptExecutionContext, RaisesException] IDBRequest getKey(IDBKeyRange? key);
     44     [CallWith=ScriptExecutionContext, RaisesException] IDBRequest getKey(any key);
     45 
     46     [CallWith=ScriptExecutionContext, RaisesException] IDBRequest count([Default=Undefined] optional IDBKeyRange? range);
     47     [CallWith=ScriptExecutionContext, RaisesException] IDBRequest count(any key);
     48 };
     49