| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_container_XNameAccess_idl__ |
| #define __com_sun_star_container_XNameAccess_idl__ |
| |
| #ifndef __com_sun_star_container_XElementAccess_idl__ |
| #include <com/sun/star/container/XElementAccess.idl> |
| #endif |
| |
| #ifndef __com_sun_star_container_NoSuchElementException_idl__ |
| #include <com/sun/star/container/NoSuchElementException.idl> |
| #endif |
| |
| #ifndef __com_sun_star_lang_WrappedTargetException_idl__ |
| #include <com/sun/star/lang/WrappedTargetException.idl> |
| #endif |
| |
| //============================================================================= |
| |
| 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 |
| <type scope="com::sun::star::beans">XExactName</type> |
| 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 <type scope="com::sun::star::lang">WrappedTargetException</type> |
| 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 <member>XNameAccess::getByName</member>. |
| You should optimize this case. </p> |
| |
| @param aName |
| the name of the object. |
| */ |
| boolean hasByName( [in] string aName ); |
| |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| #endif |