storage/public/mozIStorageError.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 "nsISupports.idl"
  41
  42 %{C++
  43 #ifdef ERROR
  44 #undef ERROR
  45 #endif
  46 %}
  47
  48 [scriptable, uuid(1f350f96-7023-434a-8864-40a1c493aac1)]
  49 interface mozIStorageError : nsISupports {
  50
  51   /**
  52    * General SQL error or missing database.
  53    */
  54   const long ERROR = 1;
  55
  56   /**
  57    * Internal logic error.
  58    */
  59   const long INTERNAL = 2;
  60
  61   /**
  62    * Access permission denied.
  63    */
  64   const long PERM = 3;
  65
  66   /**
  67    * A callback routine requested an abort.
  68    */
  69   const long ABORT = 4;
  70
  71   /**
  72    * The database file is locked.
  73    */
  74   const long BUSY = 5;
  75
  76   /**
  77    * A table in the database is locked.
  78    */
  79   const long LOCKED = 6;
  80
  81   /**
  82    * An allocation failed.
  83    */
  84   const long NOMEM = 7;
  85
  86   /**
  87    * Attempt to write to a readonly database.
  88    */
  89   const long READONLY = 8;
  90
  91   /**
  92    * Operation was terminated by an interrupt.
  93    */
  94   const long INTERRUPT = 9;
  95
  96   /**
  97    * Some kind of disk I/O error occurred.
  98    */
  99   const long IOERR = 10;
 100
 101   /**
 102    * The database disk image is malformed.
 103    */
 104   const long CORRUPT = 11;
 105
 106   /**
 107    * An insertion failed because the database is full.
 108    */
 109   const long FULL = 13;
 110
 111   /**
 112    * Unable to open the database file.
 113    */
 114   const long CANTOPEN = 14;
 115
 116   /**
 117    * The database is empty.
 118    */
 119   const long EMPTY = 16;
 120
 121   /**
 122    * The database scheme changed.
 123    */
 124   const long SCHEMA = 17;
 125
 126   /**
 127    * A string or blob exceeds the size limit.
 128    */
 129   const long TOOBIG = 18;
 130
 131   /**
 132    * Abort due to a constraint violation.
 133    */
 134   const long CONSTRAINT = 19;
 135
 136   /**
 137    * Data type mismatch.
 138    */
 139   const long MISMATCH = 20;
 140
 141   /**
 142    * Library used incorrectly.
 143    */
 144   const long MISUSE = 21;
 145
 146   /**
 147    * Uses OS features not supported on the host system.
 148    */
 149   const long NOLFS = 22;
 150
 151   /**
 152    * Authorization denied.
 153    */
 154   const long AUTH = 23;
 155
 156   /**
 157    * Auxiliary database format error.
 158    */
 159   const long FORMAT = 24;
 160
 161   /**
 162    * Attempt to bind a parameter using an out-of-range index or nonexistent
 163    * named parameter name.
 164    */
 165   const long RANGE = 25;
 166
 167   /**
 168    * File opened that is not a database file.
 169    */
 170   const long NOTADB = 26;
 171
 172
 173   /**
 174    * Indicates what type of error occurred.
 175    */
 176   readonly attribute long result;
 177
 178   /**
 179    * An error string the gives more details, if available.
 180    */
 181   readonly attribute AUTF8String message;
 182 };