offapi/com/sun/star/xml/input/XNamespaceMapping.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: XNamespaceMapping.idl,v $
  10  * $Revision: 1.5 $
  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 #if ! defined INCLUDED_com_sun_star_sax_input_XUidMapping_idl
  32 #define INCLUDED_com_sun_star_sax_input_XUidMapping_idl
  33
  34 #include <com/sun/star/container/NoSuchElementException.idl>
  35
  36
  37 module com { module sun { module star { module xml { module input {
  38
  39 /** Interface to map XML namespace URI strings to ordinals (URI-id, short uid).
  40
  41     @internal
  42 */
  43 interface XNamespaceMapping : com::sun::star::uno::XInterface
  44 {
  45     /** Creates a unique ordinal passing an XML namespace URI.
  46
  47         @param uri
  48                XML namespace URI
  49         @return
  50                 uid
  51      */
  52     long getUidByUri( [in] string uri );
  53
  54     /** Gets the corresponding XML namespace URI passing a uid (created using
  55         getUidByUri()).
  56
  57         @param uid
  58                uid
  59         @return
  60                XML namespace URI
  61     */
  62     string getUriByUid( [in] long uid )
  63         raises (com::sun::star::container::NoSuchElementException);
  64 };
  65
  66 }; }; }; }; };
  67
  68 #endif