xref: /trunk/main/offapi/com/sun/star/script/provider/XScriptProvider.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_script_provider_XScriptProvider_idl__
#define __com_sun_star_script_provider_XScriptProvider_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_script_provider_XScript_idl__
#include <com/sun/star/script/provider/XScript.idl>
#endif
#ifndef __com_sun_star_script_provider_ScriptFrameworkErrorException_idl__
#include <com/sun/star/script/provider/ScriptFrameworkErrorException.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

//===========================================================================

module com { module sun { module star { module script { module provider {

//===========================================================================
/**
    This interface provides a factory for obtaining objects implmenting the
    XScript interface.
*/
interface XScriptProvider : ::com::sun::star::uno::XInterface {

    //----------------------------------------------------------------------
    /** a factory method for the creation of XScript
        implementations.

        @param sScriptURI
            is the logical or language-dependent script URI

        @returns
            an object implementing <type scope="::com::sun::star::script::provider">XScript</type> representing the script

        @throws ::com::sun::star::provider::ScriptFrameworkErrorException
            Framework error getting  script for URI.
    */
	XScript getScript( [in] string sScriptURI )  raises ( ::com::sun::star::script::provider::ScriptFrameworkErrorException );
};

//===========================================================================
}; }; }; }; }; // ::com::sun::star::script::provider

#endif