1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_script_provider_XScript_idl__ 25cdf0e10cSrcweir#define __com_sun_star_script_provider_XScript_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 32cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir#ifndef __com_sun_star_script_CannotConvertException_idl__ 36cdf0e10cSrcweir#include <com/sun/star/script/CannotConvertException.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir#ifndef __com_sun_star_reflection_InvocationTargetException_idl__ 40cdf0e10cSrcweir#include <com/sun/star/reflection/InvocationTargetException.idl> 41cdf0e10cSrcweir#endif 42cdf0e10cSrcweir 43cdf0e10cSrcweir#ifndef __com_sun_star_script_provider_ScriptFrameworkErrorException_idl__ 44cdf0e10cSrcweir#include <com/sun/star/script/provider/ScriptFrameworkErrorException.idl> 45cdf0e10cSrcweir#endif 46cdf0e10cSrcweir 47cdf0e10cSrcweir//=========================================================================== 48cdf0e10cSrcweir 49cdf0e10cSrcweirmodule com { module sun { module star { module script { module provider { 50cdf0e10cSrcweir 51cdf0e10cSrcweir//=========================================================================== 52cdf0e10cSrcweir/** 53cdf0e10cSrcweir This interface represents an invokable script or UNO function. 54cdf0e10cSrcweir*/ 55cdf0e10cSrcweirinterface XScript : ::com::sun::star::uno::XInterface { 56cdf0e10cSrcweir 57cdf0e10cSrcweir //---------------------------------------------------------------------- 58cdf0e10cSrcweir /** 59cdf0e10cSrcweir invoke the script or function represented by the implementing 60cdf0e10cSrcweir object 61cdf0e10cSrcweir 62cdf0e10cSrcweir @param aParams 63cdf0e10cSrcweir all parameters; pure, out params are undefined in sequence, 64cdf0e10cSrcweir i.e., the value has to be ignored by the callee 65cdf0e10cSrcweir @param aOutParamIndex 66cdf0e10cSrcweir out indices, indicating the position of the out or inout 67cdf0e10cSrcweir parameters in the list of arguments to the script 68cdf0e10cSrcweir @param aOutParam 69cdf0e10cSrcweir out parameters<p> 70cdf0e10cSrcweir For example, if the script had the signature<br> 71cdf0e10cSrcweir <code>long foo( [inout] string a, [in] string b, [out] string c )</code> 72cdf0e10cSrcweir <br> the call would look like<br> 73cdf0e10cSrcweir <code>bar.invoke( {"foo", "foo2", "this-is-ignored" }, aOutParamIndex, aOutParam);</code> 74cdf0e10cSrcweir <br> and after the call the out sequences would contain<br> 75cdf0e10cSrcweir <listing> 76cdf0e10cSrcweir aOutParamIndex={0,2}; 77cdf0e10cSrcweir aOutParam={"string from a", "string from c"}; 78cdf0e10cSrcweir </listing> 79cdf0e10cSrcweir 80cdf0e10cSrcweir @returns 81cdf0e10cSrcweir the value returned from the function being invoked 82cdf0e10cSrcweir 83cdf0e10cSrcweir @throws ::com::sun::star::reflection::InvocationTargetException 84cdf0e10cSrcweir 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. 85cdf0e10cSrcweir */ 86cdf0e10cSrcweir any invoke( 87cdf0e10cSrcweir [in] sequence<any> aParams, 88cdf0e10cSrcweir [out] sequence<short> aOutParamIndex, 89cdf0e10cSrcweir [out] sequence<any> aOutParam ) raises( 90cdf0e10cSrcweir ::com::sun::star::script::provider::ScriptFrameworkErrorException , 91cdf0e10cSrcweir ::com::sun::star::reflection::InvocationTargetException); 92cdf0e10cSrcweir 93cdf0e10cSrcweir}; 94cdf0e10cSrcweir 95cdf0e10cSrcweir//=========================================================================== 96cdf0e10cSrcweir}; }; }; }; }; // ::com::sun::star::script::provider 97cdf0e10cSrcweir 98cdf0e10cSrcweir#endif 99