xref: /aoo41x/main/offapi/com/sun/star/script/provider/ScriptURIHelper.idl (revision d5bd2f9e)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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