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