toolkit/components/places/public/nsPIPlacesDatabase.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=2 sts=2
   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 Places 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 interface mozIStorageConnection;
  43
  44 /**
  45  * This is a private interface used by Places components to get access to the
  46  * database.  If outside consumers wish to use this, they should only read from
  47  * the database so they do not break any internal invariants.
  48  */
  49 [scriptable, uuid(8e6d4f8a-4b8e-4026-9fca-517c4494ddb7)]
  50 interface nsPIPlacesDatabase : nsISupports
  51 {
  52   /**
  53    * The database connection used by Places.
  54    */
  55   readonly attribute mozIStorageConnection DBConnection;
  56
  57   /**
  58    * Finalizes all Places internal statements, allowing to safely close the
  59    * database connection.
  60    */
  61   void finalizeInternalStatements();
  62
  63   /**
  64    * Commits all pending history changes, call this before finalizing
  65    * statements and closing the database connection to ensure safety for all
  66    * history data.
  67    */
  68   void commitPendingChanges();
  69 };