1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_container_XNameAccess_idl__ 24#define __com_sun_star_container_XNameAccess_idl__ 25 26#ifndef __com_sun_star_container_XElementAccess_idl__ 27#include <com/sun/star/container/XElementAccess.idl> 28#endif 29 30#ifndef __com_sun_star_container_NoSuchElementException_idl__ 31#include <com/sun/star/container/NoSuchElementException.idl> 32#endif 33 34#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 35#include <com/sun/star/lang/WrappedTargetException.idl> 36#endif 37 38//============================================================================= 39 40module com { module sun { module star { module container { 41 42//============================================================================= 43 44/** is used to access named objects within a container. 45 46 <p>To implement inaccurate name access, support the 47 <type scope="com::sun::star::beans">XExactName</type> 48 interface. </p> 49 @see com::sun::star::beans::XExactName 50 */ 51published interface XNameAccess: com::sun::star::container::XElementAccess 52{ 53 //------------------------------------------------------------------------- 54 55 /** @returns 56 the object with the specified name. 57 58 @param aName 59 the name of the object. 60 61 @throws NoSuchElementException 62 if an element under Name does not exist. 63 64 @throws com::sun::star::lang::WrappedTargetException 65 If the implementation has internal reasons for exceptions, 66 then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type> 67 exception. 68 */ 69 any getByName( [in] string aName ) 70 raises( com::sun::star::container::NoSuchElementException, 71 com::sun::star::lang::WrappedTargetException ); 72 73 //------------------------------------------------------------------------- 74 75 /** @returns 76 a sequence of all element names in this container. 77 78 <p>The order of the names is not specified. </p> 79 */ 80 sequence<string> getElementNames(); 81 82 //------------------------------------------------------------------------- 83 84 /** @returns 85 <TRUE/> if an element with this name is in 86 the container, <FALSE/> otherwise. 87 88 <p>In many cases the next call is <member>XNameAccess::getByName</member>. 89 You should optimize this case. </p> 90 91 @param aName 92 the name of the object. 93 */ 94 boolean hasByName( [in] string aName ); 95 96}; 97 98//============================================================================= 99 100}; }; }; }; 101 102#endif 103