xref: /aoo42x/main/offapi/com/sun/star/xml/input/XNamespaceMapping.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#if ! defined INCLUDED_com_sun_star_sax_input_XUidMapping_idl
#define INCLUDED_com_sun_star_sax_input_XUidMapping_idl

#include <com/sun/star/container/NoSuchElementException.idl>


module com { module sun { module star { module xml { module input {

/** Interface to map XML namespace URI strings to ordinals (URI-id, short uid).

    @internal
*/
interface XNamespaceMapping : com::sun::star::uno::XInterface
{
    /** Creates a unique ordinal passing an XML namespace URI.

        @param uri
               XML namespace URI
        @return
                uid
     */
    long getUidByUri( [in] string uri );

    /** Gets the corresponding XML namespace URI passing a uid (created using
        getUidByUri()).

        @param uid
               uid
        @return
               XML namespace URI
    */
    string getUriByUid( [in] long uid )
        raises (com::sun::star::container::NoSuchElementException);
};

}; }; }; }; };

#endif