offapi/com/sun/star/script/provider/XScriptProviderFactory.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: XScriptProviderFactory.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_XScriptProviderFactory_idl__
  32 #define __com_sun_star_script_provider_XScriptProviderFactory_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_XScriptProvider_idl__
  38 #include <com/sun/star/script/provider/XScriptProvider.idl>
  39 #endif
  40 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  41 #include <com/sun/star/lang/IllegalArgumentException.idl>
  42 #endif
  43
  44 //===========================================================================
  45
  46 module com { module sun { module star { module script { module provider {
  47
  48 //===========================================================================
  49 /**
  50     This interface provides a factory for obtaining objects implmenting the
  51     XScriptProvider interface.
  52 */
  53 interface XScriptProviderFactory : ::com::sun::star::uno::XInterface {
  54
  55     //----------------------------------------------------------------------
  56     /** a factory method for the creation of XScriptProviders
  57         implementations.
  58
  59         @param sContext
  60             is context for which the ScriptProvider is to be created for
  61
  62         @returns
  63             an object implementing <type scope="::com::sun::star::script::provider">XScriptProvider</type>
  64
  65         @throws ::com::sun::star::lang::IllegalArgumentException
  66             if illegal or unknown context is passed
  67     */
  68     XScriptProvider createScriptProvider( [in] any context )  raises (
  69         ::com::sun::star::lang::IllegalArgumentException );
  70 };
  71
  72 //===========================================================================
  73 }; }; }; }; }; // ::com::sun::star::script::provider
  74
  75 #endif