offapi/com/sun/star/script/XLibraryContainerPassword.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 #ifndef __com_sun_star_script_XLibraryContainerPassword_idl__
  20 #define __com_sun_star_script_XLibraryContainerPassword_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25
  26 #include <com/sun/star/container/NoSuchElementException.idl>
  27
  28
  29
  30  module com {  module sun {  module star {  module script {
  31
  32
  33 /**
  34     Extension of XLibraryContainer to provide password functionality.
  35     This interface should be implemented together with XLibraryContainer2
  36     </p>
  37  */
  38 published interface XLibraryContainerPassword:  com::sun::star::uno::XInterface
  39 {
  40     /**
  41         Returns true if the accessed library item is protected
  42         by a password.
  43
  44         If a library with the this name doesn't exist a
  45         com::sun::star::container::NoSuchElementException is thrown.
  46      */
  47     boolean isLibraryPasswordProtected( [in] string Name )
  48             raises( com::sun::star::container::NoSuchElementException );
  49
  50     /**
  51         Returns true if the accessed library item is protected by a
  52         password (see isLibraryPasswordProtected) and the password
  53         was already verified with verifyLibraryPassword or if an
  54         initial password was set with changeLibraryPassword.
  55
  56         If a library with the this name doesn't exist a
  57         com::sun::star::container::NoSuchElementException is thrown.
  58
  59         If the library exists but isn't password protected a
  60         com::sun::star::lang::IllegalArgumentException is thrown.
  61      */
  62     boolean isLibraryPasswordVerified( [in] string Name )
  63             raises( com::sun::star::lang::IllegalArgumentException,
  64                     com::sun::star::container::NoSuchElementException );
  65
  66     /**
  67         Verifies the library's password. If the correct password
  68         was passed, the method returns true and further calls to
  69         isLibraryPasswordVerified will also return true.
  70
  71         If a library with the this name doesn't exist a
  72         com::sun::star::container::NoSuchElementException is thrown.
  73
  74         If the library exists but isn't password protected a
  75         com::sun::star::lang::IllegalArgumentException is thrown.
  76
  77         If the library password is already verified a
  78         com::sun::star::lang::IllegalArgumentException is thrown.
  79      */
  80     boolean verifyLibraryPassword( [in] string Name, [in] string Password )
  81             raises( com::sun::star::lang::IllegalArgumentException,
  82                     com::sun::star::container::NoSuchElementException );
  83
  84     /**
  85         Changes the library's password.
  86
  87         If the library wasn't password protected before:
  88         The OldPassword parameter has to be an empty string.
  89         Afterwards calls to isLibraryPasswordProtected and
  90         isLibraryPasswordVerified for this library will
  91         return true.
  92
  93         If the library already was password protected:
  94         The OldPassword parameter has to be set to the
  95         previous defined password. If then the NewPassword
  96         parameter is an empty string the library password
  97         protection will be disabled afterwards (afterwards
  98         calls to isLibraryPasswordProtected for this library
  99         will return false). If the NewPassword parameter is
 100         not an empty string it will accepted as the new
 101         password for the library.
 102
 103         If a library with the this name doesn't exist but isn't
 104         com::sun::star::container::NoSuchElementException is thrown.
 105
 106         If the library exists and is password protected and a
 107         wrong OldPassword is passed to the method a
 108         com::sun::star::lang::IllegalArgumentException is thrown.
 109
 110         If the library exists and isn't password protected and
 111         the OldPassword isn't an empty string or the library is
 112         read only a
 113         com::sun::star::lang::IllegalArgumentException is thrown.
 114      */
 115     void changeLibraryPassword( [in] string Name,
 116         [in] string OldPassword, [in] string NewPassword )
 117             raises( com::sun::star::lang::IllegalArgumentException,
 118                     com::sun::star::container::NoSuchElementException );
 119
 120 };
 121
 122
 123
 124 }; }; }; };
 125
 126 #endif
 127
 128 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */