diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 05:54:39 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-15 05:54:39 +0000 |
commit | 267c6f2ac71f92999e969232431ba04678e7437e (patch) | |
tree | 358c9467650e1d0a1d7227a21dac2e3d08b622b2 /offapi/com/sun/star/script/XLibraryContainerPassword.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-267c6f2ac71f92999e969232431ba04678e7437e.tar.xz libreoffice-267c6f2ac71f92999e969232431ba04678e7437e.zip |
Adding upstream version 4:24.2.0.upstream/4%24.2.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/script/XLibraryContainerPassword.idl')
-rw-r--r-- | offapi/com/sun/star/script/XLibraryContainerPassword.idl | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/offapi/com/sun/star/script/XLibraryContainerPassword.idl b/offapi/com/sun/star/script/XLibraryContainerPassword.idl new file mode 100644 index 0000000000..6cf382f40a --- /dev/null +++ b/offapi/com/sun/star/script/XLibraryContainerPassword.idl @@ -0,0 +1,118 @@ +/* -*- 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 { + + +/** + Extension of XLibraryContainer to provide password functionality. + This interface should be implemented together with XLibraryContainer2 + </p> + */ +published interface XLibraryContainerPassword: com::sun::star::uno::XInterface +{ + /** + Returns true if the accessed library item is protected + by a password. + + If a library with the this name doesn't exist a + com::sun::star::container::NoSuchElementException is thrown. + */ + boolean isLibraryPasswordProtected( [in] string Name ) + raises( com::sun::star::container::NoSuchElementException ); + + /** + Returns true if the accessed library item is protected by a + password (see isLibraryPasswordProtected) and the password + was already verified with verifyLibraryPassword or if an + initial password was set with changeLibraryPassword. + + If a library with the this name doesn't exist a + com::sun::star::container::NoSuchElementException is thrown. + + If the library exists but isn't password protected a + com::sun::star::lang::IllegalArgumentException is thrown. + */ + boolean isLibraryPasswordVerified( [in] string Name ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::NoSuchElementException ); + + /** + Verifies the library's password. If the correct password + was passed, the method returns true and further calls to + isLibraryPasswordVerified will also return true. + + If a library with the this name doesn't exist a + com::sun::star::container::NoSuchElementException is thrown. + + If the library exists but isn't password protected a + com::sun::star::lang::IllegalArgumentException is thrown. + + If the library password is already verified a + com::sun::star::lang::IllegalArgumentException is thrown. + */ + boolean verifyLibraryPassword( [in] string Name, [in] string Password ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::NoSuchElementException ); + + /** + Changes the library's password. + + If the library wasn't password protected before: + The OldPassword parameter has to be an empty string. + Afterwards calls to isLibraryPasswordProtected and + isLibraryPasswordVerified for this library will + return true. + + If the library already was password protected: + The OldPassword parameter has to be set to the + previous defined password. If then the NewPassword + parameter is an empty string the library password + protection will be disabled afterwards (afterwards + calls to isLibraryPasswordProtected for this library + will return false). If the NewPassword parameter is + not an empty string it will accepted as the new + password for the library. + + If a library with the this name doesn't exist but isn't + com::sun::star::container::NoSuchElementException is thrown. + + If the library exists and is password protected and a + wrong OldPassword is passed to the method a + com::sun::star::lang::IllegalArgumentException is thrown. + + If the library exists and isn't password protected and + the OldPassword isn't an empty string or the library is + read only a + com::sun::star::lang::IllegalArgumentException is thrown. + */ + void changeLibraryPassword( [in] string Name, + [in] string OldPassword, [in] string NewPassword ) + raises( com::sun::star::lang::IllegalArgumentException, + com::sun::star::container::NoSuchElementException ); + +}; + + + +}; }; }; }; + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |