storage/public/mozIStorageRow.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=2 sts=2 expandtab
   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) 2008
  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 "mozIStorageValueArray.idl"
  41 interface nsIVariant;
  42
  43 [scriptable, uuid(62d1b6bd-cbfe-4f9b-aee1-0ead4af4e6dc)]
  44 interface mozIStorageRow : mozIStorageValueArray {
  45
  46   /**
  47    * Obtains the result of a given column specified by aIndex.
  48    *
  49    * @param aIndex
  50    *        Zero-based index of the result to get from the tuple.
  51    * @returns the result of the specified column.
  52    */
  53   nsIVariant getResultByIndex(in unsigned long aIndex);
  54
  55   /**
  56    * Obtains the result of a given column specified by aName.
  57    *
  58    * @param aName
  59    *        Name of the result to get from the tuple.
  60    * @returns the result of the specified column.
  61    * @note The name of a result column is the value of the "AS" clause for that
  62    *       column.  If there is no AS clause then the name of the column is
  63    *       unspecified and may change from one release to the next.
  64    */
  65   nsIVariant getResultByName(in AUTF8String aName);
  66 };