/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_container_XIndexAccess_idl__
#define __com_sun_star_container_XIndexAccess_idl__

#include <com/sun/star/container/XElementAccess.idl>

#include <com/sun/star/lang/IndexOutOfBoundsException.idl>

#include <com/sun/star/lang/WrappedTargetException.idl>



module com {  module sun {  module star {  module container {


/** provides access to the elements of a collection through an
    index.

    <p>This interface should only be used if the data structure, itself,
    is indexed.</p>
 */
published interface XIndexAccess: com::sun::star::container::XElementAccess
{

    /** @returns
                the number of elements in this container.
     */
    long getCount();

    /** @returns
            the element at the specified index.

        @param Index
            specifies the position in the array. The first index is 0.

        @throws com::sun::star::lang::IndexOutOfBoundException
            if the index is not valid.

        @throws  com::sun::star::lang::WrappedTargetException
            If the implementation has internal reasons for exceptions,
            then wrap these in a com::sun::star::lang::WrappedTargetException
            exception.
     */
    any getByIndex( [in] long Index )
            raises( com::sun::star::lang::IndexOutOfBoundsException,
                    com::sun::star::lang::WrappedTargetException );

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
