offapi/com/sun/star/script/provider/XScriptProvider.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: XScriptProvider.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_XScriptProvider_idl__
  32 #define __com_sun_star_script_provider_XScriptProvider_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_script_provider_XScript_idl__
  38 #include <com/sun/star/script/provider/XScript.idl>
  39 #endif
  40 #ifndef __com_sun_star_script_provider_ScriptFrameworkErrorException_idl__
  41 #include <com/sun/star/script/provider/ScriptFrameworkErrorException.idl>
  42 #endif
  43 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  44 #include <com/sun/star/lang/IllegalArgumentException.idl>
  45 #endif
  46
  47 //===========================================================================
  48
  49 module com { module sun { module star { module script { module provider {
  50
  51 //===========================================================================
  52 /**
  53     This interface provides a factory for obtaining objects implmenting the
  54     XScript interface.
  55 */
  56 interface XScriptProvider : ::com::sun::star::uno::XInterface {
  57
  58     //----------------------------------------------------------------------
  59     /** a factory method for the creation of XScript
  60         implementations.
  61
  62         @param sScriptURI
  63             is the logical or language-dependent script URI
  64
  65         @returns
  66             an object implementing <type scope="::com::sun::star::script::provider">XScript</type> representing the script
  67
  68         @throws ::com::sun::star::provider::ScriptFrameworkErrorException
  69             Framework error getting  script for URI.
  70     */
  71     XScript getScript( [in] string sScriptURI )  raises ( ::com::sun::star::script::provider::ScriptFrameworkErrorException );
  72 };
  73
  74 //===========================================================================
  75 }; }; }; }; }; // ::com::sun::star::script::provider
  76
  77 #endif