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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com { module sun { module star { module xml { module dom {
  21
  22 interface XNode;
  23
  24 interface XNamedNodeMap : com::sun::star::uno::XInterface
  25 {
  26
  27     /**
  28     The number of nodes in this map.
  29     */
  30     long getLength();
  31
  32     /**
  33     Retrieves a node specified by local name.
  34     */
  35     XNode getNamedItem([in] string name);
  36
  37     /**
  38     Retrieves a node specified by local name and namespace URI.
  39     */
  40     XNode getNamedItemNS([in] string namespaceURI,[in]  string localName);
  41
  42     /**
  43     Returns a node specified by index.
  44     */
  45     XNode item([in] long index);
  46
  47     /**
  48     Removes a node specified by name.
  49     Throws:
  50     DOMException - NOT_FOUND_ERR: Raised if there is no node named name in this map.
  51     NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
  52     */
  53     XNode removeNamedItem([in] string name) raises (DOMException);
  54
  55     /**
  56     Removes a node specified by local name and namespace URI.
  57     Throws:
  58     DOMException - NOT_FOUND_ERR: Raised if there is no node with the specified namespaceURI and localName in this map.
  59     NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
  60     */
  61     XNode removeNamedItemNS([in] string namespaceURI, [in] string localName) raises (DOMException);
  62
  63     /**
  64     Adds a node using its nodeName attribute.
  65     Throws:
  66     DOMException - WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created this map.
  67     NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
  68     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.
  69     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.
  70     */
  71     XNode setNamedItem([in] XNode arg) raises (DOMException);
  72
  73     /**
  74     Adds a node using its namespaceURI and localName.
  75     Throws:
  76     DOMException - WRONG_DOCUMENT_ERR: Raised if arg was created from a different document than the one that created this map.
  77     NO_MODIFICATION_ALLOWED_ERR: Raised if this map is readonly.
  78     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.
  79     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.
  80     NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, since namespaces were defined by XML.
  81     */
  82     XNode setNamedItemNS([in] XNode arg) raises (DOMException);
  83 };
  84 }; }; }; }; };
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */