rdf/base/idl/rdfITripleVisitor.idl

   1 /* -*- Mode: IDL; 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.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Benjamin Smedberg <bsmedberg@covad.net>.
  19  * Portions created by the Initial Developer are Copyright (C) 2004
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Axel Hecht <axel@pike.org>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40
  41 interface nsIRDFResource;
  42 interface nsIRDFNode;
  43
  44 /**
  45  * Interface used in RDF to enumerate triples.
  46  * Also used by rdfIDataSource::getAllSubjects, then aPredicate,
  47  * aObject and aTruthValue are ignored.
  48  *
  49  * @status PLASMA
  50  */
  51
  52 [scriptable, function, uuid(aafea151-c271-4505-9978-a100d292800c)]
  53 interface rdfITripleVisitor : nsISupports
  54 {
  55     /**
  56      * Callback function for returning query results.
  57      *
  58      * @param aSubject, aPredicate, aObject describe the (sub-)arc
  59      * @returnCode NS_RDF_STOP_VISIT to stop iterating over the query result.
  60      *             Any error code will stop the iteration as well.
  61      */
  62     void visit(in nsIRDFNode aSubject, in nsIRDFResource aPredicate,
  63                in nsIRDFNode aObject, in boolean aTruthValue);
  64 };