offapi/com/sun/star/script/provider/XScriptURIHelper.idl

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