offapi/com/sun/star/xml/dom/XDOMImplementation.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDOMImplementation.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_xml_dom_XDOMImplementation_idl__
  32 #define __com_sun_star_xml_dom_XDOMImplementation_idl__
  33
  34 #ifndef __com_sun_star_uno__XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_xml_dom_DOMException_idl__
  38 #include <com/sun/star/xml/dom/DOMException.idl>
  39 #endif
  40
  41
  42 module com { module sun { module star { module xml { module dom {
  43
  44 interface XDocument;
  45 interface XDocumentType;
  46
  47 interface XDOMImplementation : com::sun::star::uno::XInterface
  48 {
  49     /**
  50     Creates a DOM Document object of the specified type with its document element.
  51     Throws:
  52     DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
  53                    NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the qualifiedName has a prefix
  54                       and the namespaceURI is null, or if the qualifiedName has a prefix that is "xml" and
  55                       the namespaceURI is different from " http://www.w3.org/XML/1998/namespace" , or if the
  56                       DOM implementation does not support the "XML" feature but a non-null namespace URI was
  57                       provided, since namespaces were defined by XML.
  58                    WRONG_DOCUMENT_ERR: Raised if doctype has already been used with a different document or
  59                       was created from a different implementation.
  60                    NOT_SUPPORTED_ERR: May be raised by DOM implementations which do not support the
  61                       "XML" feature, if they choose not to support this method. Other features introduced
  62                       in the future, by the DOM WG or in extensions defined by other groups, may also
  63                       demand support for this method; please consult the definition of the feature to see
  64                       if it requires this method.
  65     */
  66     XDocument createDocument([in] string namespaceURI, [in] string qualifiedName, [in] XDocumentType doctype)
  67         raises (DOMException);
  68
  69     /**
  70     Creates an empty DocumentType node.
  71     Throws:
  72     DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
  73                    NAMESPACE_ERR: Raised if the qualifiedName is malformed.
  74                    NOT_SUPPORTED_ERR: May be raised by DOM implementations which do not support the
  75                       "XML" feature, if they choose not to support this method. Other features introduced
  76                       in the future, by the DOM WG or in extensions defined by other groups, may also demand
  77                       support for this method; please consult the definition of the feature to see if it
  78                       requires this method.
  79     */
  80     XDocumentType createDocumentType([in] string qualifiedName, [in] string publicId, [in] string systemId)
  81         raises (DOMException);
  82
  83     /**
  84     Test if the DOM implementation implements a specific feature.
  85     */
  86     boolean hasFeature([in] string feature, [in] string ver);
  87 };
  88
  89 }; }; }; }; };
  90
  91 #endif