udkapi/com/sun/star/container/XIndexAccess.idl

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