Source/WebCore/storage/IDBDatabase.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,
        EventTarget
    ] IDBDatabase {
        readonly attribute DOMString name;
        readonly attribute DOMString version;
        readonly attribute DOMStringList objectStoreNames;

        attribute EventListener onabort;
        attribute EventListener onerror;
        attribute EventListener onversionchange;

        IDBObjectStore createObjectStore(in DOMString name, in [Optional] OptionsObject options)
            raises (IDBDatabaseException);
        void deleteObjectStore(in DOMString name)
            raises (IDBDatabaseException);
        [CallWith=ScriptExecutionContext] IDBVersionChangeRequest setVersion(in DOMString version)
            raises (IDBDatabaseException);
        [CallWith=ScriptExecutionContext] IDBTransaction transaction(in [Optional] DOMStringList storeNames, in [Optional] unsigned short mode)
            raises (IDBDatabaseException);
        void close();

        // EventTarget interface
        void addEventListener(in DOMString type,
                              in EventListener listener,
                              in boolean useCapture);
        void removeEventListener(in DOMString type,
                                 in EventListener listener,
                                 in boolean useCapture);
        boolean dispatchEvent(in Event evt)
            raises(EventException);
    };

}