sbIDatabaseQuery.idl

Go to the documentation of this file.

/*
 //
// BEGIN SONGBIRD GPL
// 
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
// 
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
// 
// Software distributed under the License is distributed 
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either 
// express or implied. See the GPL for the specific language 
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this 
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc., 
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
// 
// END SONGBIRD GPL
//
 */

#include "nsISupports.idl"

interface nsIURI;
interface sbIDatabaseResult;
interface sbIDatabasePreparedStatement;

[scriptable, uuid(918745AE-0F40-4d08-BA4E-27A739459952)]
interface sbIDatabaseSimpleQueryCallback : nsISupports
{
  void onQueryEnd(in sbIDatabaseResult dbResultObject, in AString dbGUID, in AString strQuery);
};


[scriptable, uuid(A901158A-3735-44fd-9AD2-1753F1407284)]
interface sbIDatabaseQueryCallback : nsISupports
{
  void onQueryError(in long dbError, in AString dbGUID, in AString strQuery);

  void onQueryStart(in AString dbGUID, in AString strQuery);

  void onQueryRow(in sbIDatabaseResult dbResultObject, in unsigned long dbRowResult, in unsigned long dbRowTotal);

  void onQueryEnd(in sbIDatabaseResult dbResultObject, in AString dbGUID, in AString strQuery); 
};

[scriptable, uuid(192FE564-1D86-49c8-A31A-5798D62B2525)]
interface sbIDatabaseQuery : nsISupports
{
  attribute nsIURI databaseLocation;

  void setAsyncQuery(in PRBool bAsyncQuery);

  PRBool isAyncQuery();
  
  void addSimpleQueryCallback(in sbIDatabaseSimpleQueryCallback dbPersistCB);

  void removeSimpleQueryCallback(in sbIDatabaseSimpleQueryCallback dbPersistCB);

  void setDatabaseGUID(in AString dbGUID);

  AString getDatabaseGUID();

  void addQuery(in AString strQuery);

  sbIDatabasePreparedStatement prepareQuery(in AString strQuery);
  
  void addPreparedStatement(in sbIDatabasePreparedStatement PreparedStatement);

  unsigned long getQueryCount();

  sbIDatabasePreparedStatement getQuery(in unsigned long nIndex);

  void resetQuery();
  
  sbIDatabaseResult getResultObject();

  long getLastError();

  void setLastError(in long dbError);

  long execute();

  long waitForCompletion();

  boolean isExecuting();

  unsigned long currentQuery();

  boolean abort();

  attribute unsigned long long rollingLimit;

  attribute unsigned long rollingLimitColumnIndex;

  attribute unsigned long rollingLimitResult;

  void bindUTF8StringParameter(in unsigned long aParamIndex,
                               in AUTF8String aValue);

  void bindStringParameter(in unsigned long aParamIndex,
                           in AString aValue);

  void bindDoubleParameter(in unsigned long aParamIndex,
                           in double aValue);

  void bindInt32Parameter(in unsigned long aParamIndex,
                          in long aValue);

  void bindInt64Parameter(in unsigned long aParamIndex,
                          in long long aValue);

  void bindNullParameter(in unsigned long aParamIndex);
};