storage/public/mozIStorageBindingParams.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=2 sts=2 et
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Mozilla Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 2009
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Shawn Wilsher <me@shawnwilsher.com> (Original Author)
  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 nsIVariant;
  43
  44 [scriptable, uuid(a8d4827c-641c-45e3-a9ea-493570b4106b)]
  45 interface mozIStorageBindingParams : nsISupports {
  46   /**
  47    * Binds aValue to the parameter with the name aName.
  48    *
  49    * @param aName
  50    *        The name of the parameter to bind aValue to.
  51    * @param aValue
  52    *        The value to bind.
  53    */
  54    void bindByName(in AUTF8String aName,
  55                    in nsIVariant aValue);
  56    [noscript] void bindUTF8StringByName(in AUTF8String aName,
  57                                         in AUTF8String aValue);
  58    [noscript] void bindStringByName(in AUTF8String aName,
  59                                     in AString aValue);
  60    [noscript] void bindDoubleByName(in AUTF8String aName,
  61                                     in double aValue);
  62    [noscript] void bindInt32ByName(in AUTF8String aName,
  63                                    in long aValue);
  64    [noscript] void bindInt64ByName(in AUTF8String aName,
  65                                    in long long aValue);
  66    [noscript] void bindNullByName(in AUTF8String aName);
  67    void bindBlobByName(in AUTF8String aName,
  68                        [array, const, size_is(aValueSize)] in octet aValue,
  69                        in unsigned long aValueSize);
  70
  71    /**
  72     * Binds aValue to the parameter with the index aIndex.
  73     *
  74     * @param aIndex
  75     *        The zero-based index of the parameter to bind aValue to.
  76     * @param aValue
  77     *        The value to bind.
  78     */
  79    void bindByIndex(in unsigned long aIndex,
  80                     in nsIVariant aValue);
  81    [noscript] void bindUTF8StringByIndex(in unsigned long aIndex,
  82                                          in AUTF8String aValue);
  83    [noscript] void bindStringByIndex(in unsigned long aIndex,
  84                                      in AString aValue);
  85    [noscript] void bindDoubleByIndex(in unsigned long aIndex,
  86                                      in double aValue);
  87    [noscript] void bindInt32ByIndex(in unsigned long aIndex,
  88                                     in long aValue);
  89    [noscript] void bindInt64ByIndex(in unsigned long aIndex,
  90                                     in long long aValue);
  91    [noscript] void bindNullByIndex(in unsigned long aIndex);
  92    void bindBlobByIndex(in unsigned long aIndex,
  93                         [array, const, size_is(aValueSize)] in octet aValue,
  94                         in unsigned long aValueSize);
  95 };