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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_container_XIndexAccess_idl__
  20 #define __com_sun_star_container_XIndexAccess_idl__
  21
  22 #include <com/sun/star/container/XElementAccess.idl>
  23
  24 #include <com/sun/star/lang/IndexOutOfBoundsException.idl>
  25
  26 #include <com/sun/star/lang/WrappedTargetException.idl>
  27
  28
  29
  30 module com {  module sun {  module star {  module container {
  31
  32
  33 /** provides access to the elements of a collection through an
  34     index.
  35
  36     <p>This interface should only be used if the data structure, itself,
  37     is indexed.</p>
  38  */
  39 published interface XIndexAccess: com::sun::star::container::XElementAccess
  40 {
  41
  42     /** @returns
  43                 the number of elements in this container.
  44      */
  45     long getCount();
  46
  47     /** @returns
  48             the element at the specified index.
  49
  50         @param Index
  51             specifies the position in the array. The first index is 0.
  52
  53         @throws com::sun::star::lang::IndexOutOfBoundException
  54             if the index is not valid.
  55
  56         @throws  com::sun::star::lang::WrappedTargetException
  57             If the implementation has internal reasons for exceptions,
  58             then wrap these in a com::sun::star::lang::WrappedTargetException
  59             exception.
  60      */
  61     any getByIndex( [in] long Index )
  62             raises( com::sun::star::lang::IndexOutOfBoundsException,
  63                     com::sun::star::lang::WrappedTargetException );
  64
  65 };
  66
  67
  68 }; }; }; };
  69
  70 #endif
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */