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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_script_provider_XScriptURIHelper_idl__
  21 #define __com_sun_star_script_provider_XScriptURIHelper_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25
  26
  27
  28 module com { module sun { module star { module script { module provider {
  29
  30 /**
  31     This interface is used to help transform Scripting Framework storage
  32     locations to Scripting Framework script URIs and vice versa.
  33 */
  34 interface XScriptURIHelper : ::com::sun::star::uno::XInterface {
  35
  36     /**
  37         Obtain the root storage URI for this ScriptURIHelper. The
  38         resulting string can be used to access the storage for this
  39         using the Universal Content Broker
  40
  41         @returns a URI to the storage as a `string`
  42     */
  43     string getRootStorageURI();
  44
  45     /**
  46         Obtain the storage URI for a specific Scripting Framework
  47         script URI.
  48
  49         @returns a URI to the storage as a `string`
  50
  51         @throws ::com::sun::star::lang::IllegalArgumentException
  52             if the storageURI is not a valid
  53     */
  54     string getStorageURI( [in] string scriptURI ) raises
  55         ( ::com::sun::star::lang::IllegalArgumentException );
  56
  57     /**
  58         Obtain the Scripting Framework script URI for a specific UCB URI
  59
  60         @returns the URI as a `string`
  61
  62         @throws ::com::sun::star::lang::IllegalArgumentException
  63             if the storageURI is not a valid
  64     */
  65     string getScriptURI( [in] string storageURI ) raises
  66         ( ::com::sun::star::lang::IllegalArgumentException );
  67 };
  68
  69 }; }; }; }; }; // ::com::sun::star::script::provider
  70
  71 #endif
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */