storage/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  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "mozIStorageValueArray.idl"
   8 interface nsIVariant;
   9
  10 [scriptable, uuid(62d1b6bd-cbfe-4f9b-aee1-0ead4af4e6dc)]
  11 interface mozIStorageRow : mozIStorageValueArray {
  12
  13   /**
  14    * Obtains the result of a given column specified by aIndex.
  15    *
  16    * @param aIndex
  17    *        Zero-based index of the result to get from the tuple.
  18    * @returns the result of the specified column.
  19    */
  20   nsIVariant getResultByIndex(in unsigned long aIndex);
  21
  22   /**
  23    * Obtains the result of a given column specified by aName.
  24    *
  25    * @param aName
  26    *        Name of the result to get from the tuple.
  27    * @returns the result of the specified column.
  28    * @note The name of a result column is the value of the "AS" clause for that
  29    *       column.  If there is no AS clause then the name of the column is
  30    *       unspecified and may change from one release to the next.
  31    */
  32   nsIVariant getResultByName(in AUTF8String aName);
  33 };