offapi/com/sun/star/xml/dom/XNamedNodeMap.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: XNamedNodeMap.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_XNamedNodeMap_idl__
  32 #define __com_sun_star_xml_dom_XNamedNodeMap_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 module com { module sun { module star { module xml { module dom {
  42
  43 interface XNode;
  44
  45 interface XNamedNodeMap : com::sun::star::uno::XInterface
  46 {
  47
  48     /**
  49     The number of nodes in this map.
  50     */
  51     long getLength();
  52
  53     /**
  54     Retrieves a node specified by local name
  55     */
  56     XNode getNamedItem([in] string name);
  57
  58     /**
  59     Retrieves a node specified by local name and namespace URI.
  60     */
  61     XNode getNamedItemNS([in] string namespaceURI,[in]  string localName);
  62
  63     /**
  64     Returns the indexth item in the map.
  65     */
  66     XNode item([in] long index);
  67
  68     /**
  69     Removes a node specified by name.
  70     Throws:
  71     DOMException - NOT_FOUND_ERR: Raised if there is no node named name in this map.
  72     NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
  73     */
  74     XNode removeNamedItem([in] string name) raises (DOMException);
  75
  76     /**
  77     Removes a node specified by local name and namespace URI.
  78     Throws:
  79     DOMException - NOT_FOUND_ERR: Raised if there is no node with the specified namespaceURI and localName in this map.
  80     NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
  81     */
  82     XNode removeNamedItemNS([in] string namespaceURI, [in] string localName) raises (DOMException);
  83
  84     /**
  85     Adds a node using its nodeName attribute.
  86     Throws:
  87     DOMException - WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created this map.
  88     NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
  89     INUSE_ATTRIBUTE_ERR: Raised if arg is an Attr that is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.
  90     HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities.
  91     */
  92     XNode setNamedItem([in] XNode arg) raises (DOMException);
  93
  94     /**
  95     Adds a node using its namespaceURI and localName.
  96     Throws:
  97     DOMException - WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created this map.
  98     NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
  99     INUSE_ATTRIBUTE_ERR: Raised if arg is an Attr that is already an attribute of another Element object. The DOM user must explicitly clone Attr nodes to re-use them in other elements.
 100     HIERARCHY_REQUEST_ERR: Raised if an attempt is made to add a node doesn't belong in this NamedNodeMap. Examples would include trying to insert something other than an Attr node into an Element's map of attributes, or a non-Entity node into the DocumentType's map of Entities.
 101     NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.
 102     */
 103     XNode setNamedItemNS([in] XNode arg) raises (DOMException);
 104 };
 105 }; }; }; }; };
 106
 107 #endif