xref: /trunk/main/offapi/com/sun/star/script/provider/ScriptURIHelper.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_ScriptURIHelper_idl__
#define __com_sun_star_script_provider_ScriptURIHelper_idl__

#ifndef __com_sun_star_script_provider_XScriptURIHelper_idl__
#include <com/sun/star/script/provider/XScriptURIHelper.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 service is used to help transform Scripting Framework storage
    locations to Scripting Framework script URIs and vice versa.
*/
service ScriptURIHelper : XScriptURIHelper {

    /**
        create a new ScriptURIHelper

		@param language
            The name of the scripting language for which this ScriptURIHelper
            is being created. It should be the same as the language name
            used for the service that inherits from the LanguageScriptProvider
            service

		@param location
            This location which was passed to the LanguageScriptProvider
            by the Scripting Framework on its creation

        @throws
            <type scope="::com::sun::star::lang">IllegalArgumentException</type>
    */
    create( [in] string language, [in] string location )
        raises ( ::com::sun::star::lang::IllegalArgumentException );
};

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

#endif