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
  21
  22 module com { module sun { module star { module script { module provider {
  23
  24 /**
  25     This interface is used to help transform Scripting Framework storage
  26     locations to Scripting Framework script URIs and vice versa.
  27 */
  28 interface XScriptURIHelper : ::com::sun::star::uno::XInterface {
  29
  30     /**
  31         Obtain the root storage URI for this ScriptURIHelper. The
  32         resulting string can be used to access the storage for this
  33         using the Universal Content Broker
  34
  35         @returns a URI to the storage as a `string`
  36     */
  37     string getRootStorageURI();
  38
  39     /**
  40         Obtain the storage URI for a specific Scripting Framework
  41         script URI.
  42
  43         @returns a URI to the storage as a `string`
  44
  45         @throws ::com::sun::star::lang::IllegalArgumentException
  46             if the storageURI is not a valid
  47     */
  48     string getStorageURI( [in] string scriptURI ) raises
  49         ( ::com::sun::star::lang::IllegalArgumentException );
  50
  51     /**
  52         Obtain the Scripting Framework script URI for a specific UCB URI
  53
  54         @returns the URI as a `string`
  55
  56         @throws ::com::sun::star::lang::IllegalArgumentException
  57             if the storageURI is not a valid
  58     */
  59     string getScriptURI( [in] string storageURI ) raises
  60         ( ::com::sun::star::lang::IllegalArgumentException );
  61 };
  62
  63 }; }; }; }; }; // ::com::sun::star::script::provider
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */