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_XIndexAccess_idl__
24#define __com_sun_star_container_XIndexAccess_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_lang_IndexOutOfBoundsException_idl__
31#include <com/sun/star/lang/IndexOutOfBoundsException.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//=============================================================================
40
41module com {  module sun {  module star {  module container {
42
43//=============================================================================
44
45/** provides access to the elements of a collection through an
46	index.
47
48	<p>This interface should only be used if the data structure, itself,
49	is indexed.</p>
50 */
51published interface XIndexAccess: com::sun::star::container::XElementAccess
52{
53	//-------------------------------------------------------------------------
54
55	/** @returns
56				the number of elements in this container.
57	 */
58	long getCount();
59
60	//-------------------------------------------------------------------------
61
62	// DocMerge from idl: method com::sun::star::container::XIndexAccess::getByIndex
63	/** @returns
64			the element at the specified index.
65
66		@param Index
67			specifies the position in the array. The first index is 0.
68
69		@throws com::sun::star::lang::IndexOutOfBoundException
70			if the index is not valid.
71
72		@throws  com::sun::star::lang::WrappedTargetException
73			If the implementation has internal reasons for exceptions,
74			then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type>
75			exception.
76	 */
77	any getByIndex( [in] long Index )
78			raises( com::sun::star::lang::IndexOutOfBoundsException,
79					com::sun::star::lang::WrappedTargetException );
80
81};
82
83//=============================================================================
84
85}; }; }; };
86
87#endif
88