udkapi/com/sun/star/container/XNameAccess.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 #ifndef __com_sun_star_container_XNameAccess_idl__
  20 #define __com_sun_star_container_XNameAccess_idl__
  21
  22 #include <com/sun/star/container/XElementAccess.idl>
  23
  24 #include <com/sun/star/container/NoSuchElementException.idl>
  25
  26 #include <com/sun/star/lang/WrappedTargetException.idl>
  27
  28
  29 module com {  module sun {  module star {  module container {
  30
  31
  32 /** is used to access named objects within a container.
  33
  34     <p>To implement inaccurate name access, support the
  35     com::sun::star::beans::XExactName
  36     interface.  </p>
  37     @see com::sun::star::beans::XExactName
  38  */
  39 published interface XNameAccess: com::sun::star::container::XElementAccess
  40 {
  41
  42     /** @returns
  43         the object with the specified name.
  44
  45         @param aName
  46             the name of the object.
  47
  48         @throws NoSuchElementException
  49             if an element under Name does not exist.
  50
  51         @throws  com::sun::star::lang::WrappedTargetException
  52             If the implementation has internal reasons for exceptions,
  53             then wrap these in a com::sun::star::lang::WrappedTargetException
  54             exception.
  55      */
  56     any getByName( [in] string aName )
  57             raises( com::sun::star::container::NoSuchElementException,
  58                     com::sun::star::lang::WrappedTargetException );
  59
  60
  61     /** @returns
  62             a sequence of all element names in this container.
  63
  64         <p>The order of the names is not specified. </p>
  65      */
  66     sequence<string> getElementNames();
  67
  68
  69     /** @returns
  70             `TRUE` if an element with this name is in
  71             the container, `FALSE` otherwise.
  72
  73         <p>In many cases the next call is XNameAccess::getByName().
  74         You should optimize this case.  </p>
  75
  76         @param aName
  77             the name of the object.
  78      */
  79     boolean hasByName( [in] string aName );
  80
  81 };
  82
  83
  84 }; }; }; };
  85
  86 #endif
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */