Quelle  XNameAccess.idl

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */


module com {  module sun {  module star {  module container {


/** is used to access named objects within a container.

    <p>To implement inaccurate name access, support the
    com::sun::star::beans::XExactName
    interface.  </p>
    @see com::sun::star::beans::XExactName
 */
published interface XNameAccess: com::sun::star::container::XElementAccess
{

    /** @returns
        the object with the specified name.

        @param aName
            the name of the object.

        @throws NoSuchElementException
            if an element under Name does not exist.

        @throws  com::sun::star::lang::WrappedTargetException
            If the implementation has internal reasons for exceptions,
            then wrap these in a com::sun::star::lang::WrappedTargetException
            exception.
     */
    any getByName( [in] string aName )
            raises( com::sun::star::container::NoSuchElementException,
                    com::sun::star::lang::WrappedTargetException );


    /** @returns
            a sequence of all element names in this container.

        <p>The order of the names is not specified. </p>
     */
    sequence<string> getElementNames();


    /** @returns
            `TRUE` if an element with this name is in
            the container, `FALSE` otherwise.

        <p>In many cases the next call is XNameAccess::getByName().
        You should optimize this case.  </p>

        @param aName
            the name of the object.
     */
    boolean hasByName( [in] string aName );

};


}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */