offapi/com/sun/star/task/XMasterPasswordHandling.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 task {
  23
  24 /** allows to change the master password, or let it be requested and checked.
  25 */
  26 published interface XMasterPasswordHandling : com::sun::star::uno::XInterface
  27 {
  28     /** allows to check the user authorization.
  29
  30         <p>
  31         This call let the master password be requested from user using the
  32         provided interaction handler.
  33         </p>
  34
  35         <p>
  36         The call will use the standard interaction handler service
  37         InteractionHandler if no handler is provided.
  38         </p>
  39
  40     */
  41     boolean authorizateWithMasterPassword( [in] XInteractionHandler xHandler );
  42
  43     /** allows to change the master password.
  44
  45         <p>
  46         If there is still no master password, the user will be asked to provide
  47         the new one.
  48         </p>
  49
  50         <p>
  51         The call will use the standard interaction handler service
  52         InteractionHandler if no handler is provided.
  53         </p>
  54     */
  55     boolean changeMasterPassword( [in] XInteractionHandler xHandler );
  56
  57     /** let the master password and all the related stored passwords be
  58         removed.
  59     */
  60     void removeMasterPassword();
  61
  62     /** allows to detect whether there is already a master password
  63     */
  64     boolean hasMasterPassword();
  65
  66     /** allows to specify whether persistent storing of passwords is allowed
  67
  68         <p>
  69         After the storing is forbidden the master password and all the stored
  70         passwords are removed.
  71         </p>
  72     */
  73     boolean allowPersistentStoring( [in] boolean bAllow );
  74
  75     /** allows to detect whether persistent storing of passwords is allowed
  76     */
  77     boolean isPersistentStoringAllowed();
  78
  79 };
  80
  81
  82 }; }; }; };
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */