offapi/com/sun/star/script/provider/XScriptProvider.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_script_provider_XScriptProvider_idl__
  21 #define __com_sun_star_script_provider_XScriptProvider_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/script/provider/XScript.idl>
  25 #include <com/sun/star/script/provider/ScriptFrameworkErrorException.idl>
  26 #include <com/sun/star/lang/IllegalArgumentException.idl>
  27
  28
  29 module com { module sun { module star { module script { module provider {
  30
  31 /**
  32     This interface provides a factory for obtaining objects implementing the
  33     XScript interface.
  34 */
  35 interface XScriptProvider : ::com::sun::star::uno::XInterface {
  36
  37     /** a factory method for the creation of XScript
  38         implementations.
  39
  40         @param sScriptURI
  41             is the logical or language-dependent script URI
  42
  43         @returns
  44             an object implementing ::com::sun::star::script::provider::XScript representing the script
  45
  46         @throws ::com::sun::star::script::provider::ScriptFrameworkErrorException
  47             Framework error getting  script for URI.
  48     */
  49     XScript getScript( [in] string sScriptURI )  raises ( ::com::sun::star::script::provider::ScriptFrameworkErrorException );
  50 };
  51
  52 }; }; }; }; }; // ::com::sun::star::script::provider
  53
  54 #endif
  55
  56 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */