Bug 518440 - Deprecate mozIStorageStatementWrapper & mozIStorageStatement.step() in IDL. r=sdwilsh
authorPaul O’Shannessy <paul@oshannessy.com>
Fri, 25 Sep 2009 15:32:21 -0700
changeset 33075 5e6a413226d213625fc803bb323ad5411a37d28d
parent 33074 1aaedcad1634af0ab3ef390b71e8955aab3ca45d
child 33076 95a13b05a24fad49ffd5e3a97230e7d127ef26bc
push idunknown
push userunknown
push dateunknown
reviewerssdwilsh
bugs518440
milestone1.9.3a1pre
Bug 518440 - Deprecate mozIStorageStatementWrapper & mozIStorageStatement.step() in IDL. r=sdwilsh
storage/public/mozIStorageStatement.idl
storage/public/mozIStorageStatementWrapper.idl
--- a/storage/public/mozIStorageStatement.idl
+++ b/storage/public/mozIStorageStatement.idl
@@ -145,17 +145,17 @@ interface mozIStorageStatement : mozISto
    *
    * @returns a mozIStorageBindingParamsArray that multiple sets of parameters
    *          can be bound to.
    */
   mozIStorageBindingParamsArray newBindingParamsArray();
 
   /**
    * Execute the query, ignoring any results.  This is accomplished by
-   * calling step() once, and then calling reset().
+   * calling executeStep() once, and then calling reset().
    *
    * Error and last insert info, etc. are available from
    * the mozStorageConnection.
    */
   void execute();
 
   /**
    * Execute a query, using any currently-bound parameters.  Reset
@@ -169,19 +169,21 @@ interface mozIStorageStatement : mozISto
    */
   boolean executeStep();
 
   /**
    * Execute a query, using any currently-bound parameters.  Reset is called
    * when no more data is returned.  This method is only available to JavaScript
    * consumers.
    *
+   * @deprecated As of Mozilla 1.9.2 in favor of executeStep().
+   *
    * @returns a boolean indicating whether there are more rows or not.
    *
-   * boolean step();
+   * [deprecated] boolean step();
    */
 
   /**
    * Obtains the current list of named parameters, which are settable.  This
    * property is only available to JavaScript consumers.
    *
    * readonly attribute mozIStorageStatementParams params;
    */
--- a/storage/public/mozIStorageStatementWrapper.idl
+++ b/storage/public/mozIStorageStatementWrapper.idl
@@ -44,33 +44,37 @@ interface mozIStorageStatementRow : nsIS
   // for by-name access to rows
 };
 
 [scriptable, uuid(e65fe6e2-2643-463c-97e2-27665efe2386)]
 interface mozIStorageStatementParams : nsISupports {
   // magic interface for parameter setting that implements nsIXPCScriptable.
 };
 
-[scriptable, uuid(eee6f7c9-5586-4eaf-b35c-dca987c4ffd1)]
+/**
+ * @deprecated As of Mozilla 1.9.2.  Methods are already provided on
+ *             mozIStorageStatement.
+ */
+[scriptable, deprecated, uuid(eee6f7c9-5586-4eaf-b35c-dca987c4ffd1)]
 interface mozIStorageStatementWrapper : nsISupports {
   /**
    * Initialize this wrapper with aStatement.
    */
   void initialize(in mozIStorageStatement aStatement);
 
   /**
    * The statement that is wrapped.
    */
   readonly attribute mozIStorageStatement statement;
 
   /**
    * Step, reset, and execute the wrapped statement.
    */
   void reset();
-  boolean step();
+  [deprecated] boolean step();
   void execute();
 
   /**
    * The current row.  Throws an exception if no row is currently
    * available.  Useful only from script.  The value of this is only
    * valid while the statement is still executing, and is still on the
    * appropriate row.
    */