elemental/idl/third_party/WebCore/Modules/indexeddb/IDBCursor.idl

/*
 * Copyright (C) 2010 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

module storage {

    interface [
        Conditional=INDEXED_DATABASE,
    ] IDBCursor {
        // FIXME: Eventually remove legacy enum constants, see https://bugs.webkit.org/show_bug.cgi?id=85315
        const unsigned short NEXT = 0;
        const unsigned short NEXT_NO_DUPLICATE = 1;
        const unsigned short PREV = 2;
        const unsigned short PREV_NO_DUPLICATE = 3;

        readonly attribute DOMString direction;
        readonly attribute IDBKey key;
        readonly attribute IDBKey primaryKey;
        readonly attribute IDBAny source;

        [CallWith=ScriptExecutionContext] IDBRequest update(in SerializedScriptValue value)
            raises (IDBDatabaseException);
        void advance(in unsigned long count)
            raises (IDBDatabaseException);
        [ImplementedAs=continueFunction] void continue(in [Optional] IDBKey key)
            raises (IDBDatabaseException);
        [CallWith=ScriptExecutionContext, ImplementedAs=deleteFunction] IDBRequest delete()
            raises (IDBDatabaseException);
    };
}