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_XIdentifierAccess_idl__
24#define __com_sun_star_container_XIdentifierAccess_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/** provides access to the elements of a collection through a unique identifier.
45 */
46published interface XIdentifierAccess: com::sun::star::container::XElementAccess
47{
48	/** @returns
49			the element with the specified identifier
50
51		@param Identifier
52			specifies the identifier of the element that should be retrieved.
53
54		@throws com::sun::star::lang::NoSuchElementException
55			If the identifier is not existing.
56
57		@throws  com::sun::star::lang::WrappedTargetException
58			If the implementation has internal reasons for exceptions,
59			then wrap these in a <typee scope="com::sun::star::lang">WrappedTargetException</type>
60			exception.
61	 */
62	any getByIdentifier( [in] long Identifierr )
63			raises( com::sun::star::container::NoSuchElementException,
64					com::sun::star::lang::WrappedTargetException );
65
66	// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
67	/** @returns
68			a sequence of all identifiers in this container.
69
70		<p>The order of the identifiers is not specified. </p>
71	 */
72	sequence<long> getIdentifiers();
73}
74;
75
76//=============================================================================
77
78}; }; }; };
79
80#endif
81