rdf/base/idl/nsIRDFObserver.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39 #include "nsIRDFResource.idl"
  40 #include "nsIRDFNode.idl"
  41
  42 interface nsIRDFDataSource;
  43
  44 // An nsIRDFObserver object is an observer that will be notified
  45 // when assertions are made or removed from a datasource
  46 [scriptable, uuid(3CC75360-484A-11D2-BC16-00805F912FE7)]
  47 interface nsIRDFObserver : nsISupports {
  48     /**
  49      * This method is called whenever a new assertion is made
  50      * in the data source
  51      * @param aDataSource the datasource that is issuing
  52      *   the notification.
  53      * @param aSource the subject of the assertion
  54      * @param aProperty the predicate of the assertion
  55      * @param aTarget the object of the assertion
  56      */
  57     void onAssert(in nsIRDFDataSource aDataSource,
  58                   in nsIRDFResource aSource,
  59                   in nsIRDFResource aProperty,
  60                   in nsIRDFNode     aTarget);
  61
  62     /**
  63      * This method is called whenever an assertion is removed
  64      * from the data source
  65      * @param aDataSource the datasource that is issuing
  66      *   the notification.
  67      * @param aSource the subject of the assertion
  68      * @param aProperty the predicate of the assertion
  69      * @param aTarget the object of the assertion
  70      */
  71     void onUnassert(in nsIRDFDataSource aDataSource,
  72                     in nsIRDFResource aSource,
  73                     in nsIRDFResource aProperty,
  74                     in nsIRDFNode     aTarget);
  75
  76     /**
  77      * This method is called when the object of an assertion
  78      * changes from one value to another.
  79      * @param aDataSource the datasource that is issuing
  80      *   the notification.
  81      * @param aSource the subject of the assertion
  82      * @param aProperty the predicate of the assertion
  83      * @param aOldTarget the old object of the assertion
  84      * @param aNewTarget the new object of the assertion
  85      */
  86     void onChange(in nsIRDFDataSource aDataSource,
  87                   in nsIRDFResource aSource,
  88                   in nsIRDFResource aProperty,
  89                   in nsIRDFNode     aOldTarget,
  90                   in nsIRDFNode     aNewTarget);
  91
  92     /**
  93      * This method is called when the subject of an assertion
  94      * changes from one value to another.
  95      * @param aDataSource the datasource that is issuing
  96      *   the notification.
  97      * @param aOldSource the old subject of the assertion
  98      * @param aNewSource the new subject of the assertion
  99      * @param aProperty the predicate of the assertion
 100      * @param aTarget the object of the assertion
 101      */
 102     void onMove(in nsIRDFDataSource aDataSource,
 103                 in nsIRDFResource aOldSource,
 104                 in nsIRDFResource aNewSource,
 105                 in nsIRDFResource aProperty,
 106                 in nsIRDFNode     aTarget);
 107
 108     /**
 109      * This method is called when a datasource is about to
 110      * send several notifications at once. The observer can
 111      * use this as a cue to optimize its behavior. The observer
 112      * can expect the datasource to call endUpdateBatch() when
 113      * the group of notifications has completed.
 114      * @param aDataSource the datasource that is going to
 115      *   be issuing the notifications.
 116      */
 117     void onBeginUpdateBatch(in nsIRDFDataSource aDataSource);
 118
 119     /**
 120      * This method is called when a datasource has completed
 121      * issuing a notification group.
 122      * @param aDataSource the datasource that has finished
 123      *   issuing a group of notifications
 124      */
 125     void onEndUpdateBatch(in nsIRDFDataSource aDataSource);
 126 };