Source/WebCore/storage/IDBRequest.idl

   1 /*
   2  * Copyright (C) 2010 Google Inc. All rights reserved.
   3  * Copyright (C) 2011 Apple Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1.  Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  * 2.  Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  15  *     its contributors may be used to endorse or promote products derived
  16  *     from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 module storage {
  31
  32     interface [
  33         Conditional=INDEXED_DATABASE,
  34         ActiveDOMObject,
  35         EventTarget
  36     ] IDBRequest {
  37         readonly attribute IDBAny result
  38             getter raises (IDBDatabaseException);
  39         readonly attribute unsigned short errorCode
  40             getter raises (IDBDatabaseException);
  41         readonly attribute [ConvertNullStringTo=Undefined] DOMString webkitErrorMessage
  42             getter raises (IDBDatabaseException);
  43         readonly attribute IDBAny source;
  44         readonly attribute IDBTransaction transaction;
  45
  46         // States
  47         const unsigned short LOADING = 1;
  48         const unsigned short DONE = 2;
  49         readonly attribute unsigned short readyState;
  50
  51         // Events
  52         attribute EventListener onsuccess;
  53         attribute EventListener onerror;
  54
  55         // EventTarget interface
  56         void addEventListener(in DOMString type,
  57                               in EventListener listener,
  58                               in [Optional] boolean useCapture);
  59         void removeEventListener(in DOMString type,
  60                                  in EventListener listener,
  61                                  in [Optional] boolean useCapture);
  62         boolean dispatchEvent(in Event evt)
  63             raises(EventException);
  64     };
  65 }