1*408a4873SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*408a4873SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*408a4873SAndrew Rist * distributed with this work for additional information 6*408a4873SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*408a4873SAndrew Rist * "License"); you may not use this file except in compliance 9*408a4873SAndrew Rist * with the License. You may obtain a copy of the License at 10cdf0e10cSrcweir * 11*408a4873SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12cdf0e10cSrcweir * 13*408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*408a4873SAndrew Rist * software distributed under the License is distributed on an 15*408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*408a4873SAndrew Rist * KIND, either express or implied. See the License for the 17*408a4873SAndrew Rist * specific language governing permissions and limitations 18*408a4873SAndrew Rist * under the License. 19cdf0e10cSrcweir * 20*408a4873SAndrew Rist *************************************************************/ 21*408a4873SAndrew Rist 22*408a4873SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexAccess_idl__ 24cdf0e10cSrcweir#define __com_sun_star_container_XIndexAccess_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_container_XElementAccess_idl__ 27cdf0e10cSrcweir#include <com/sun/star/container/XElementAccess.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 31cdf0e10cSrcweir#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 35cdf0e10cSrcweir#include <com/sun/star/lang/WrappedTargetException.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir 41cdf0e10cSrcweirmodule com { module sun { module star { module container { 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir 45cdf0e10cSrcweir/** provides access to the elements of a collection through an 46cdf0e10cSrcweir index. 47cdf0e10cSrcweir 48cdf0e10cSrcweir <p>This interface should only be used if the data structure, itself, 49cdf0e10cSrcweir is indexed.</p> 50cdf0e10cSrcweir */ 51cdf0e10cSrcweirpublished interface XIndexAccess: com::sun::star::container::XElementAccess 52cdf0e10cSrcweir{ 53cdf0e10cSrcweir //------------------------------------------------------------------------- 54cdf0e10cSrcweir 55cdf0e10cSrcweir /** @returns 56cdf0e10cSrcweir the number of elements in this container. 57cdf0e10cSrcweir */ 58cdf0e10cSrcweir long getCount(); 59cdf0e10cSrcweir 60cdf0e10cSrcweir //------------------------------------------------------------------------- 61cdf0e10cSrcweir 62cdf0e10cSrcweir // DocMerge from idl: method com::sun::star::container::XIndexAccess::getByIndex 63cdf0e10cSrcweir /** @returns 64cdf0e10cSrcweir the element at the specified index. 65cdf0e10cSrcweir 66cdf0e10cSrcweir @param Index 67cdf0e10cSrcweir specifies the position in the array. The first index is 0. 68cdf0e10cSrcweir 69cdf0e10cSrcweir @throws com::sun::star::lang::IndexOutOfBoundException 70cdf0e10cSrcweir if the index is not valid. 71cdf0e10cSrcweir 72cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 73cdf0e10cSrcweir If the implementation has internal reasons for exceptions, 74cdf0e10cSrcweir then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type> 75cdf0e10cSrcweir exception. 76cdf0e10cSrcweir */ 77cdf0e10cSrcweir any getByIndex( [in] long Index ) 78cdf0e10cSrcweir raises( com::sun::star::lang::IndexOutOfBoundsException, 79cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 80cdf0e10cSrcweir 81cdf0e10cSrcweir}; 82cdf0e10cSrcweir 83cdf0e10cSrcweir//============================================================================= 84cdf0e10cSrcweir 85cdf0e10cSrcweir}; }; }; }; 86cdf0e10cSrcweir 87cdf0e10cSrcweir#endif 88