1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* ***** BEGIN LICENSE BLOCK *****
3 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 *
5 * The contents of this file are subject to the Mozilla Public License Version
6 * 1.1 (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 * http://www.mozilla.org/MPL/
9 *
10 * Software distributed under the License is distributed on an "AS IS" basis,
11 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 * for the specific language governing rights and limitations under the
13 * License.
14 *
15 * The Original Code is Oracle Corporation code.
16 *
17 * The Initial Developer of the Original Code is
18 * Oracle Corporation
19 * Portions created by the Initial Developer are Copyright (C) 2004
20 * the Initial Developer. All Rights Reserved.
21 *
22 * Contributor(s):
23 * Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
24 * Lev Serebryakov <lev@serebryakov.spb.ru>
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * either the GNU General Public License Version 2 or later (the "GPL"), or
28 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
29 * in which case the provisions of the GPL or the LGPL are applicable instead
30 * of those above. If you wish to allow use of your version of this file only
31 * under the terms of either the GPL or the LGPL, and not to allow others to
32 * use your version of this file under the terms of the MPL, indicate your
33 * decision by deleting the provisions above and replace them with the notice
34 * and other provisions required by the GPL or the LGPL. If you do not delete
35 * the provisions above, a recipient may use your version of this file under
36 * the terms of any one of the MPL, the GPL or the LGPL.
37 *
38 * ***** END LICENSE BLOCK ***** */
39
40 #include "nsISupports.idl"
41
42 interface mozIStorageConnection;
43 interface mozIStorageValueArray;
44 interface nsIArray;
45 interface nsIVariant;
46
47 /**
48 * mozIStorageFunction is to be implemented by storage consumers that
49 * wish to receive callbacks during the request execution.
50 *
51 * SQL can apply functions to values from tables. Examples of
52 * such functions are MIN(a1,a2) or SQRT(num). Many functions are
53 * implemented in SQL engine.
54 *
55 * This interface allows consumers to implement their own,
56 * problem-specific functions.
57 * These functions can be called from triggers, too.
58 *
59 */
60 [scriptable, uuid(9ff02465-21cb-49f3-b975-7d5b38ceec73)]
61 interface mozIStorageFunction : nsISupports {
62 /**
63 * onFunctionCall is called when execution of a custom
64 * function should occur.
65 *
66 * @param aNumArguments The number of arguments
67 * @param aFunctionArguments The arguments passed in to the function
68 *
69 * @returns any value as Variant type.
70 */
71
72 nsIVariant onFunctionCall(in mozIStorageValueArray aFunctionArguments);
73 };