offapi/com/sun/star/script/provider/XScript.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: XScript.idl,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef __com_sun_star_script_provider_XScript_idl__
  32 #define __com_sun_star_script_provider_XScript_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  39 #include <com/sun/star/lang/IllegalArgumentException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_script_CannotConvertException_idl__
  43 #include <com/sun/star/script/CannotConvertException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_reflection_InvocationTargetException_idl__
  47 #include <com/sun/star/reflection/InvocationTargetException.idl>
  48 #endif
  49
  50 #ifndef  __com_sun_star_script_provider_ScriptFrameworkErrorException_idl__
  51 #include <com/sun/star/script/provider/ScriptFrameworkErrorException.idl>
  52 #endif
  53
  54 //===========================================================================
  55
  56 module com { module sun { module star { module script { module provider {
  57
  58 //===========================================================================
  59 /**
  60     This interface represents an invokable script or UNO function.
  61 */
  62 interface XScript : ::com::sun::star::uno::XInterface {
  63
  64     //----------------------------------------------------------------------
  65     /**
  66         invoke the script or function represented by the implementing
  67             object
  68
  69         @param aParams
  70             all parameters; pure, out params are undefined in sequence,
  71             i.e., the value has to be ignored by the callee
  72         @param aOutParamIndex
  73             out indices, indicating the position of the out or inout
  74             parameters in the list of arguments to the script
  75         @param aOutParam
  76             out parameters<p>
  77             For example, if the script had the signature<br>
  78             <code>long foo( [inout] string a, [in] string b, [out] string c )</code>
  79             <br> the call would look like<br>
  80             <code>bar.invoke( {"foo", "foo2", "this-is-ignored" }, aOutParamIndex, aOutParam);</code>
  81             <br> and after the call the out sequences would contain<br>
  82             <listing>
  83             aOutParamIndex={0,2};
  84             aOutParam={"string from a", "string from c"};
  85             </listing>
  86
  87         @returns
  88             the value returned from the function being invoked
  89
  90         @throws ::com::sun::star::reflection::InvocationTargetException
  91             if and error occurs while attempting to invoke a script the information is captured. If the error or exception is generated by the script itself it is wrapped as either ScriptErrorRaisedException or ScriptExceptionRaisedException or ScriptingFrameworkErrorException are wrapped as ScriptFrameworkErrorExceptions.
  92     */
  93     any invoke(
  94         [in] sequence<any> aParams,
  95         [out] sequence<short> aOutParamIndex,
  96         [out] sequence<any> aOutParam ) raises(
  97         ::com::sun::star::script::provider::ScriptFrameworkErrorException ,
  98         ::com::sun::star::reflection::InvocationTargetException);
  99
 100 };
 101
 102 //===========================================================================
 103 }; }; }; }; }; // ::com::sun::star::script::provider
 104
 105 #endif