/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_sheet_XMultiFormulaTokens_idl__
#define __com_sun_star_sheet_XMultiFormulaTokens_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_sheet_FormulaToken_idl__
#include <com/sun/star/sheet/FormulaToken.idl>
#endif

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

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** gives access to multiple sets of formula tokens.

    A service implementing this interface can internally set an arbitrary
    number of formula token sequences. The number of allowed formula token
    sequences must be returned by the
    <member scope="com::sun::star::sheet">XMultiFormulaTokens::getCount</member>
    method. When the client code tries to access formula tokens at index that
    is outside the allowed index range, the implementation shall return an
    <type scope="com::sun::star::lang">IndexOutOfBoundsException</member>.
 */
interface XMultiFormulaTokens
{
    //-------------------------------------------------------------------------

    /** returns the formula at specified index as sequence of tokens.

        @throws IndexOutOfBoundsException
            If the given index lies not in the valid range then an
            <type scope="com::sun::star::lang">IndexOutOfBoundsException</type>
            exception is thrown.
     */
    sequence< FormulaToken > getTokens( [in] long nIndex )
        raises (::com::sun::star::lang::IndexOutOfBoundsException);

    //-------------------------------------------------------------------------

    /** sets the formula at specified index as sequence of tokens.

        @throws IndexOutOfBoundsException
            If the given index lies not in the valid range then an
            <type scope="com::sun::star::lang">IndexOutOfBoundsException</type>
            exception is thrown.
     */
    void setTokens( [in] long nIndex, [in] sequence< FormulaToken > aTokens )
        raises (::com::sun::star::lang::IndexOutOfBoundsException);

    //-------------------------------------------------------------------------

    /** returns the number of formulas allowed in this formula token set.

       @return the number of formulas the implementation supports.
     */
    long getCount();
};

//=============================================================================

}; }; }; };

#endif

