storage/public/mozIStorageStatementWrapper.idl

   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  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "mozIStorageStatement.idl"
  40
  41 [scriptable, uuid(02eeaf95-c3db-4182-9340-222c29f68f02)]
  42 interface mozIStorageStatementRow : nsISupports {
  43   // magic interface we return that implements nsIXPCScriptable, to allow
  44   // for by-name access to rows
  45 };
  46
  47 [scriptable, uuid(e65fe6e2-2643-463c-97e2-27665efe2386)]
  48 interface mozIStorageStatementParams : nsISupports {
  49   // magic interface for parameter setting that implements nsIXPCScriptable.
  50 };
  51
  52 [scriptable, uuid(eee6f7c9-5586-4eaf-b35c-dca987c4ffd1)]
  53 interface mozIStorageStatementWrapper : nsISupports {
  54   /**
  55    * Initialize this wrapper with aStatement.
  56    */
  57   void initialize(in mozIStorageStatement aStatement);
  58
  59   /**
  60    * The statement that is wrapped.
  61    */
  62   readonly attribute mozIStorageStatement statement;
  63
  64   /**
  65    * Step, reset, and execute the wrapped statement.
  66    */
  67   void reset();
  68   boolean step();
  69   void execute();
  70
  71   /**
  72    * The current row.  Throws an exception if no row is currently
  73    * available.  Useful only from script.  The value of this is only
  74    * valid while the statement is still executing, and is still on the
  75    * appropriate row.
  76    */
  77   readonly attribute mozIStorageStatementRow row;
  78
  79   /**
  80    * The parameters; these can be set in lieu of using the call
  81    * notation on this.
  82    */
  83   readonly attribute mozIStorageStatementParams params;
  84 };