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