diff options
Diffstat (limited to 'offapi/com/sun/star/script/provider/XScriptURIHelper.idl')
-rw-r--r-- | offapi/com/sun/star/script/provider/XScriptURIHelper.idl | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/offapi/com/sun/star/script/provider/XScriptURIHelper.idl b/offapi/com/sun/star/script/provider/XScriptURIHelper.idl new file mode 100644 index 0000000000..c829695161 --- /dev/null +++ b/offapi/com/sun/star/script/provider/XScriptURIHelper.idl @@ -0,0 +1,65 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + + + +module com { module sun { module star { module script { module provider { + +/** + This interface is used to help transform Scripting Framework storage + locations to Scripting Framework script URIs and vice versa. +*/ +interface XScriptURIHelper : ::com::sun::star::uno::XInterface { + + /** + Obtain the root storage URI for this ScriptURIHelper. The + resulting string can be used to access the storage for this + using the Universal Content Broker + + @returns a URI to the storage as a `string` + */ + string getRootStorageURI(); + + /** + Obtain the storage URI for a specific Scripting Framework + script URI. + + @returns a URI to the storage as a `string` + + @throws ::com::sun::star::lang::IllegalArgumentException + if the storageURI is not a valid + */ + string getStorageURI( [in] string scriptURI ) raises + ( ::com::sun::star::lang::IllegalArgumentException ); + + /** + Obtain the Scripting Framework script URI for a specific UCB URI + + @returns the URI as a `string` + + @throws ::com::sun::star::lang::IllegalArgumentException + if the storageURI is not a valid + */ + string getScriptURI( [in] string storageURI ) raises + ( ::com::sun::star::lang::IllegalArgumentException ); +}; + +}; }; }; }; }; // ::com::sun::star::script::provider + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |