initial import
[vuplus_webkit] / 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         LegacyDefaultOptionalArguments,
34         Conditional=INDEXED_DATABASE,
35         ActiveDOMObject,
36         EventTarget
37     ] IDBRequest {
38         readonly attribute IDBAny result
39             getter raises (IDBDatabaseException);
40         readonly attribute unsigned short errorCode
41             getter raises (IDBDatabaseException);
42         readonly attribute [ConvertNullStringTo=Undefined] DOMString webkitErrorMessage
43             getter raises (IDBDatabaseException);
44         readonly attribute IDBAny source;
45         readonly attribute IDBTransaction transaction;
46
47         // States
48         const unsigned short LOADING = 1;
49         const unsigned short DONE = 2;
50         readonly attribute unsigned short readyState;
51
52         // Events
53         attribute EventListener onsuccess;
54         attribute EventListener onerror;
55
56         // EventTarget interface
57         void addEventListener(in DOMString type,
58                               in EventListener listener,
59                               in [Optional] boolean useCapture);
60         void removeEventListener(in DOMString type,
61                                  in EventListener listener,
62                                  in [Optional] boolean useCapture);
63         boolean dispatchEvent(in Event evt)
64             raises(EventException);
65     };
66 }