/*************************************************************************
 *
 *  $RCSfile: XIdlArray.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: dbo $ $Date: 2002/03/08 17:19:13 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_reflection_XIdlArray_idl__ 
#define __com_sun_star_reflection_XIdlArray_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 
#include <com/sun/star/lang/IllegalArgumentException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_ArrayIndexOutOfBoundsException_idl__ 
#include <com/sun/star/lang/ArrayIndexOutOfBoundsException.idl> 
#endif 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module reflection {  
 
//=============================================================================
     
/** Reflects an IDL sequence and provides dynamic access to instances of
    that sequence.
    This interface supports widening conversion when getting or setting elements.
    
    @attention
    Although the name of this interface denotes arrays,
    sequences are meant. Don't be obfuscated, arrays are not supported by UNO!
*/
interface XIdlArray: com::sun::star::uno::XInterface
{ 
	/** Rellocates the length of the sequence instance.
        
        @param array
               sequence instance
        @length
                new length of sequence
	 */
	void realloc(
        [inout] any array,
        [in] long length ) 
        raises( com::sun::star::lang::IllegalArgumentException ); 
    
	/** Returns the length of the given sequence.
        
        @param array
               sequence instance
        @return
                length of sequence
    */
	long getLen( [in] any array ) 
        raises( com::sun::star::lang::IllegalArgumentException ); 
    
	/** Returns element at given index.

        @param aArray
               sequence instance
        @param nIndex
               index
        @return
                value

        @throws IllegalArgumentException  
        if the specified object is not a sequence or if the specified object is null
        
        @throws ArrayIndexOutOfBoundsException  
        if the specified index argument is negative, or if it is greater than or equal to the 
        length of the specified sequence.
    */
	any get(
        [in] any aArray, 
        [in] long nIndex ) 
        raises( com::sun::star::lang::IllegalArgumentException, 
                com::sun::star::lang::ArrayIndexOutOfBoundsException ); 
    
	/** Sets a new value at given index.

        @param aArray
               sequence instance
        @param nIndex
               index
        @param aNewValue
               new value to be set
        
        @throws IllegalArgumentException  
        if the specified object is not a sequence or if the specified object is null
        
        @throws ArrayIndexOutOfBoundsException  
        if the specified index argument is negative, or if it is greater than or equal to the 
        length of the specified sequence.
    */
	void set(
        [inout] any aArray, 
        [in] long nIndex, 
        [in] any aNewValue ) 
        raises( com::sun::star::lang::IllegalArgumentException, 
                com::sun::star::lang::ArrayIndexOutOfBoundsException );
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
	$Log: XIdlArray.idl,v $
	Revision 1.7  2002/03/08 17:19:13  dbo
	#96711# reviewed reflection API documentation
	
	Revision 1.6  2001/11/16 15:02:57  mi
	proofing by Richard Holt
	
	Revision 1.5  2001/03/16 15:10:38  jsc
	remove interfaceheader with uik and remove [const] in method definitions
	
	Revision 1.4  2000/11/08 12:28:46  mi
	moved from api
	
	Revision 1.1.1.1  2000/09/18 23:35:32  hjs
	initial import
	
	Revision 1.6  2000/09/11 11:52:36  mi
	documentation merged from XML
	 
	Revision 1.4  2000/04/20 14:09:39  mm 
	#74031# better documentation 
	 
	Revision 1.3  2000/03/20 09:53:38  mi 
	missing documentation marked 
	 
	Revision 1.2  2000/02/07 11:24:44  mi 
	zu #70728# missing documentation marked 
	 
	Revision 1.1.1.1  1999/11/11 09:48:44  jsc 
	new 
	 
 
=============================================================================*/ 
#endif 
