offapi/com/sun/star/script/provider/ScriptURIHelper.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: ScriptURIHelper.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_ScriptURIHelper_idl__
  32 #define __com_sun_star_script_provider_ScriptURIHelper_idl__
  33
  34 #ifndef __com_sun_star_script_provider_XScriptURIHelper_idl__
  35 #include <com/sun/star/script/provider/XScriptURIHelper.idl>
  36 #endif
  37 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  38 #include <com/sun/star/lang/IllegalArgumentException.idl>
  39 #endif
  40
  41 //===========================================================================
  42
  43 module com { module sun { module star { module script { module provider {
  44
  45 //===========================================================================
  46 /**
  47     This service is used to help transform Scripting Framework storage
  48     locations to Scripting Framework script URIs and vice versa.
  49 */
  50 service ScriptURIHelper : XScriptURIHelper {
  51
  52     /**
  53         create a new ScriptURIHelper
  54
  55         @param language
  56             The name of the scripting language for which this ScriptURIHelper
  57             is being created. It should be the same as the language name
  58             used for the service that inherits from the LanguageScriptProvider
  59             service
  60
  61         @param location
  62             This location which was passed to the LanguageScriptProvider
  63             by the Scripting Framework on its creation
  64
  65         @throws
  66             <type scope="::com::sun::star::lang">IllegalArgumentException</type>
  67     */
  68     create( [in] string language, [in] string location )
  69         raises ( ::com::sun::star::lang::IllegalArgumentException );
  70 };
  71
  72 //===========================================================================
  73 }; }; }; }; }; // ::com::sun::star::script::provider
  74
  75 #endif