storage/public/mozIStorageFunction.idl@8bccb770b82d (annotated)
storage/public/mozIStorageFunction.idl
Wed, 31 Dec 2014 13:27:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 13:27:57 +0100
- branch
- TOR_BUG_3246
- changeset 6
- 8bccb770b82d
- permissions
- -rw-r--r--
Ignore runtime configuration files generated during quality assurance.
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | |
| michael@0 | 8 | #include "mozIStorageValueArray.idl" |
| michael@0 | 9 | |
| michael@0 | 10 | interface mozIStorageConnection; |
| michael@0 | 11 | interface nsIArray; |
| michael@0 | 12 | interface nsIVariant; |
| michael@0 | 13 | |
| michael@0 | 14 | /** |
| michael@0 | 15 | * mozIStorageFunction is to be implemented by storage consumers that |
| michael@0 | 16 | * wish to receive callbacks during the request execution. |
| michael@0 | 17 | * |
| michael@0 | 18 | * SQL can apply functions to values from tables. Examples of |
| michael@0 | 19 | * such functions are MIN(a1,a2) or SQRT(num). Many functions are |
| michael@0 | 20 | * implemented in SQL engine. |
| michael@0 | 21 | * |
| michael@0 | 22 | * This interface allows consumers to implement their own, |
| michael@0 | 23 | * problem-specific functions. |
| michael@0 | 24 | * These functions can be called from triggers, too. |
| michael@0 | 25 | * |
| michael@0 | 26 | */ |
| michael@0 | 27 | [scriptable, function, uuid(9ff02465-21cb-49f3-b975-7d5b38ceec73)] |
| michael@0 | 28 | interface mozIStorageFunction : nsISupports { |
| michael@0 | 29 | /** |
| michael@0 | 30 | * onFunctionCall is called when execution of a custom |
| michael@0 | 31 | * function should occur. |
| michael@0 | 32 | * |
| michael@0 | 33 | * @param aNumArguments The number of arguments |
| michael@0 | 34 | * @param aFunctionArguments The arguments passed in to the function |
| michael@0 | 35 | * |
| michael@0 | 36 | * @returns any value as Variant type. |
| michael@0 | 37 | */ |
| michael@0 | 38 | |
| michael@0 | 39 | nsIVariant onFunctionCall(in mozIStorageValueArray aFunctionArguments); |
| michael@0 | 40 | }; |
