1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_task_XMasterPasswordHandling_idl__
28#define __com_sun_star_task_XMasterPasswordHandling_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_task_XInteractionHandler_idl__
35#include <com/sun/star/task/XInteractionHandler.idl>
36#endif
37
38
39//=============================================================================
40
41module com { module sun { module star { module task {
42
43//=============================================================================
44/** allows to change the master password, or let it be requested and checked.
45*/
46published interface XMasterPasswordHandling : com::sun::star::uno::XInterface
47{
48	//-------------------------------------------------------------------------
49	/** allows to check the user authorization.
50
51        <p>
52        This call let the master password be requested from user using the
53        provided interaction handler.
54        </p>
55
56        <p>
57        The call will use the standard interactin handler service
58        <type>InteractionHandler</type> if no handler is provided.
59        </p>
60
61	*/
62	boolean authorizateWithMasterPassword( [in] XInteractionHandler xHandler );
63
64	//-------------------------------------------------------------------------
65	/** allows to change the master password.
66
67        <p>
68        If there is still no master password, the user will be asked to provide
69        the new one.
70        </p>
71
72        <p>
73        The call will use the standard interaction handler service
74        <type>InteractionHandler</type> if no handler is provided.
75        </p>
76	*/
77	boolean changeMasterPassword( [in] XInteractionHandler xHandler );
78
79	//-------------------------------------------------------------------------
80	/** let the master password and all the related stored passwords be
81        removed.
82	*/
83	void removeMasterPassword();
84
85	//-------------------------------------------------------------------------
86	/** allows to detect whether there is already a master password
87	*/
88	boolean hasMasterPassword();
89
90	//-------------------------------------------------------------------------
91	/** allows to specify whether persistent storing of passwords is allowed
92
93        <p>
94        After the storing is forbidden the master password and all the stored
95        passwords are removed.
96        </p>
97	*/
98	boolean allowPersistentStoring( [in] boolean bAllow );
99
100	//-------------------------------------------------------------------------
101	/** allows to detect whether persistent storing of passwords is allowed
102	*/
103	boolean isPersistentStoringAllowed();
104
105};
106
107//=============================================================================
108
109}; }; }; };
110
111#endif
112
113