1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_script_provider_XScriptURIHelper_idl__
25#define __com_sun_star_script_provider_XScriptURIHelper_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
32#include <com/sun/star/lang/IllegalArgumentException.idl>
33#endif
34
35
36//===========================================================================
37
38module com { module sun { module star { module script { module provider {
39
40//===========================================================================
41/**
42    This interface is used to help transform Scripting Framework storage
43    locations to Scripting Framework script URIs and vice versa.
44*/
45interface XScriptURIHelper : ::com::sun::star::uno::XInterface {
46
47    //----------------------------------------------------------------------
48    /**
49        Obtain the root storage URI for this ScriptURIHelper. The
50        resulting string can be used to access the storage for this
51        using the Universal Content Broker
52
53        @returns a URI to the storage as a <atom>string</atom>
54    */
55    string getRootStorageURI();
56
57    /**
58        Obtain the storage URI for a specific Scripting Framework
59        script URI.
60
61        @returns a URI to the storage as a <atom>string</atom>
62
63        @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type>
64            if the storageURI is not a valid
65    */
66    string getStorageURI( [in] string scriptURI ) raises
67        ( ::com::sun::star::lang::IllegalArgumentException );
68
69    /**
70        Obtain the Scripting Framework script URI for a specific UCB URI
71
72        @returns the URI as a <atom>string</atom>
73
74        @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type>
75            if the storageURI is not a valid
76    */
77    string getScriptURI( [in] string storageURI ) raises
78        ( ::com::sun::star::lang::IllegalArgumentException );
79};
80
81//===========================================================================
82}; }; }; }; }; // ::com::sun::star::script::provider
83
84#endif
85