rdf/base/idl/nsIRDFContainerUtils.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 "nsIRDFContainer.idl"
  40 #include "nsIRDFResource.idl"
  41
  42
  43 // Container utilities
  44 [scriptable, uuid(D4214E91-FB94-11D2-BDD8-00104BDE6048)]
  45 interface nsIRDFContainerUtils : nsISupports {
  46     /**
  47      * Returns 'true' if the property is an RDF ordinal property.
  48      */
  49     boolean IsOrdinalProperty(in nsIRDFResource aProperty);
  50
  51     /**
  52      * Convert the specified index to an ordinal property.
  53      */
  54     nsIRDFResource IndexToOrdinalResource(in long aIndex);
  55
  56     /**
  57      * Convert the specified ordinal property into an index
  58      */
  59     long OrdinalResourceToIndex(in nsIRDFResource aOrdinal);
  60
  61     /**
  62      * Return 'true' if the specified resource is a container
  63      */
  64     boolean IsContainer(in nsIRDFDataSource aDataSource, in nsIRDFResource aResource);
  65
  66     /**
  67      * Return 'true' if the specified resource is a container and it is empty
  68      */
  69     boolean IsEmpty(in nsIRDFDataSource aDataSource, in nsIRDFResource aResource);
  70
  71     /**
  72      * Return 'true' if the specified resource is a bag
  73      */
  74     boolean IsBag(in nsIRDFDataSource aDataSource, in nsIRDFResource aResource);
  75
  76     /**
  77      * Return 'true' if the specified resource is a sequence
  78      */
  79     boolean IsSeq(in nsIRDFDataSource aDataSource, in nsIRDFResource aResource);
  80
  81     /**
  82      * Return 'true' if the specified resource is an alternation
  83      */
  84     boolean IsAlt(in nsIRDFDataSource aDataSource, in nsIRDFResource aResource);
  85
  86     /**
  87      * Decorates the specified resource appropriately to make it
  88      * usable as an empty bag in the specified data source.
  89      */
  90     nsIRDFContainer MakeBag(in nsIRDFDataSource aDataSource, in nsIRDFResource aResource);
  91
  92     /**
  93      * Decorates the specified resource appropriately to make it
  94      * usable as an empty sequence in the specified data source.
  95      */
  96     nsIRDFContainer MakeSeq(in nsIRDFDataSource aDataSource, in nsIRDFResource aResource);
  97
  98     /**
  99      * Decorates the specified resource appropriately to make it
 100      * usable as an empty alternation in the specified data source.
 101      */
 102     nsIRDFContainer MakeAlt(in nsIRDFDataSource aDataSource, in nsIRDFResource aResource);
 103
 104     /**
 105      * Retrieve the index of element in the container. Returns -1 if
 106      * the element is not in the container.
 107      */
 108     long indexOf(in nsIRDFDataSource aDataSource, in nsIRDFResource aContainer, in nsIRDFNode aElement);
 109 };
 110
 111 %{C++
 112 extern nsresult
 113 NS_NewRDFContainerUtils(nsIRDFContainerUtils** aResult);
 114 %}