1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_script_provider_XScriptURIHelper_idl__
29#define __com_sun_star_script_provider_XScriptURIHelper_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
36#include <com/sun/star/lang/IllegalArgumentException.idl>
37#endif
38
39
40//===========================================================================
41
42module com { module sun { module star { module script { module provider {
43
44//===========================================================================
45/**
46    This interface is used to help transform Scripting Framework storage
47    locations to Scripting Framework script URIs and vice versa.
48*/
49interface XScriptURIHelper : ::com::sun::star::uno::XInterface {
50
51    //----------------------------------------------------------------------
52    /**
53        Obtain the root storage URI for this ScriptURIHelper. The
54        resulting string can be used to access the storage for this
55        using the Universal Content Broker
56
57        @returns a URI to the storage as a <atom>string</atom>
58    */
59    string getRootStorageURI();
60
61    /**
62        Obtain the storage URI for a specific Scripting Framework
63        script URI.
64
65        @returns a URI to the storage as a <atom>string</atom>
66
67        @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type>
68            if the storageURI is not a valid
69    */
70    string getStorageURI( [in] string scriptURI ) raises
71        ( ::com::sun::star::lang::IllegalArgumentException );
72
73    /**
74        Obtain the Scripting Framework script URI for a specific UCB URI
75
76        @returns the URI as a <atom>string</atom>
77
78        @throws <type scope="::com::sun::star::lang">IllegalArgumentException</type>
79            if the storageURI is not a valid
80    */
81    string getScriptURI( [in] string storageURI ) raises
82        ( ::com::sun::star::lang::IllegalArgumentException );
83};
84
85//===========================================================================
86}; }; }; }; }; // ::com::sun::star::script::provider
87
88#endif
89