1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_container_XIndexAccess_idl__
28#define __com_sun_star_container_XIndexAccess_idl__
29
30#ifndef __com_sun_star_container_XElementAccess_idl__
31#include <com/sun/star/container/XElementAccess.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
35#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
36#endif
37
38#ifndef __com_sun_star_lang_WrappedTargetException_idl__
39#include <com/sun/star/lang/WrappedTargetException.idl>
40#endif
41
42
43//=============================================================================
44
45module com {  module sun {  module star {  module container {
46
47//=============================================================================
48
49/** provides access to the elements of a collection through an
50	index.
51
52	<p>This interface should only be used if the data structure, itself,
53	is indexed.</p>
54 */
55published interface XIndexAccess: com::sun::star::container::XElementAccess
56{
57	//-------------------------------------------------------------------------
58
59	/** @returns
60				the number of elements in this container.
61	 */
62	long getCount();
63
64	//-------------------------------------------------------------------------
65
66	// DocMerge from idl: method com::sun::star::container::XIndexAccess::getByIndex
67	/** @returns
68			the element at the specified index.
69
70		@param Index
71			specifies the position in the array. The first index is 0.
72
73		@throws com::sun::star::lang::IndexOutOfBoundException
74			if the index is not valid.
75
76		@throws  com::sun::star::lang::WrappedTargetException
77			If the implementation has internal reasons for exceptions,
78			then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type>
79			exception.
80	 */
81	any getByIndex( [in] long Index )
82			raises( com::sun::star::lang::IndexOutOfBoundsException,
83					com::sun::star::lang::WrappedTargetException );
84
85};
86
87//=============================================================================
88
89}; }; }; };
90
91#endif
92