Back to index

lightning-sunbird  0.9+nobinonly
mozISqlResultEnumerator.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is mozilla.org code.
00015  *
00016  * The Initial Developer of the Original Code is Jan Varga
00017  * Portions created by the Initial Developer are Copyright (C) 2003
00018  * the Initial Developer. All Rights Reserved.
00019  *
00020  * Contributor(s):
00021  *   Neil Deakin <enndeakin@sympatico.ca>
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either the GNU General Public License Version 2 or later (the "GPL"), or
00025  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 
00037 #include "nsISupports.idl"
00038 
00039 interface nsIVariant;
00040 
00054 [scriptable, uuid(dcc0d29e-2b44-460e-b39f-89121ff8b963)]
00055 interface mozISqlResultEnumerator : nsISupports
00056 {
00060   readonly attribute AString errorMessage;
00061 
00069   boolean next();
00070 
00077   boolean previous();
00078 
00082   void beforeFirst();
00083 
00087   void first();
00088 
00092   void last();
00093 
00102   void relative(in long aRows);
00103 
00110   void absolute(in long aRowIndex);
00111 
00112 
00120   boolean isNull(in long aColumnIndex);
00121 
00128   nsIVariant getVariant(in long aColumnIndex);
00129 
00137   AString getString(in long aColumnIndex);
00138 
00146   long getInt(in long aColumnIndex);
00147 
00155   float getFloat(in long aColumnIndex);
00156 
00164   float getDecimal(in long aColumnIndex);
00165 
00173   long long getDate(in long aColumnIndex);
00174 
00182   boolean getBool(in long aColumnIndex);
00183 
00184 
00192   void setNull(in long aColumnIndex);
00193 
00201   void setDefault(in long aColumnIndex);
00202 
00210   void copy(in long aColumnIndex);
00211 
00220   void setVariant(in long aColumnIndex, in nsIVariant aValue);
00221 
00230   void setString(in long aColumnIndex, in AString aValue);
00231 
00240   void setInt(in long aColumnIndex, in long aValue);
00241 
00250   void setFloat(in long aColumnIndex, in float aValue);
00251 
00260   void setDecimal(in long aColumnIndex, in float aValue);
00261 
00270   void setDate(in long aColumnIndex, in long long aValue);
00271 
00280   void setBool(in long aColumnIndex, in boolean aValue);
00281 
00282 
00287   void setNullValues();
00288 
00294   void setDefaultValues();
00295 
00302   void copyValues();
00303 
00304 
00310   boolean canInsert();
00311 
00317   boolean canUpdate();
00318 
00324   boolean canDelete();
00325 
00337   long insertRow();
00338   
00349   long updateRow();
00350 
00356   long deleteRow();
00357 
00361   readonly attribute AString currentCondition;
00362 
00363 };