1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_ucb_XInteractionSupplyAuthentication_idl__
#define __com_sun_star_ucb_XInteractionSupplyAuthentication_idl__
#ifndef __com_sun_star_task_XInteractionContinuation_idl__
#include <com/sun/star/task/XInteractionContinuation.idl>
#endif
#ifndef __com_sun_star_ucb_RememberAuthentication_idl__
#include <com/sun/star/ucb/RememberAuthentication.idl>
#endif
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** An interaction continuation handing back some authentication data.
<p> This continuation is typically used in conjunction with
<type>AuthenticationRequest</type>. </p>
*/
published interface XInteractionSupplyAuthentication: com::sun::star::task::XInteractionContinuation
{
//-------------------------------------------------------------------------
/** Specifies if a new 'realm' value can be handed back.
*/
boolean canSetRealm();
//-------------------------------------------------------------------------
/** Set a new 'realm' value to hand back.
<p>This method should be called before
<member scope="com::sun::star::task">XInteractionContinuation::select</member>,
and should only be called if
<member>XInteractionSupplyAuthentication::canSetRealm</member> returned
<true/>.</p>
*/
void setRealm( [in] string Realm );
//-------------------------------------------------------------------------
/** Specifies if a 'user name' value can be handed back.
*/
boolean canSetUserName();
//-------------------------------------------------------------------------
/** Set a new 'user name' value to hand back.
<p>This method should be called before
<member scope="com::sun::star::task">XInteractionContinuation::select</member>,
and should only be called if
<member>XInteractionSupplyAuthentication::canSetUserName</member>
returned <true/>.</p>
*/
void setUserName( [in] string UserName );
//-------------------------------------------------------------------------
/** Specifies if a 'password' value can be handed back.
*/
boolean canSetPassword();
//-------------------------------------------------------------------------
/** Set a new 'password' value to hand back.
<p>This method should be called before
<member scope="com::sun::star::task">XInteractionContinuation::select</member>,
and should only be called if
<member>XInteractionSupplyAuthentication::canSetPassword</member>
returned <true/>.</p>
*/
void setPassword( [in] string Password );
//-------------------------------------------------------------------------
/** Specifies the available modes of how long to remember the password.
@param Default
Returns the default mode (to be initially displayed to the user).
@returns
A sequence of available modes to hand back. Each individual mode
should appear at most once in the sequence. If the sequence is empty,
a new mode cannot be handed back.
*/
sequence<com::sun::star::ucb::RememberAuthentication> getRememberPasswordModes( [out] com::sun::star::ucb::RememberAuthentication Default );
//-------------------------------------------------------------------------
/** Set a new mode of how long to remember the password.
<p>This method should be called before
<member scope="com::sun::star::task">XInteractionContinuation::select</member>,
and should only be called if
<member>XInteractionSupplyAuthentication::setPassword</member>
is also called.</p>
@param Remember
The mode to hand back, should be contained in the sequence returned by
<member>XInteractionSupplyAuthentication::getRememberPasswordModes</member>.
*/
void setRememberPassword( [in] com::sun::star::ucb::RememberAuthentication Remember );
//-------------------------------------------------------------------------
/** Specifies if an 'account' value can be handed back.
*/
boolean canSetAccount();
//-------------------------------------------------------------------------
/** Set a new 'account' value to hand back.
<p>This method should be called before
<member scope="com::sun::star::task">XInteractionContinuation::select</member>,
and should only be called if
<member>XInteractionSupplyAuthentication::canSetAccount</member>
returned <true/>.</p>
*/
void setAccount( [in] string Account );
//-------------------------------------------------------------------------
/** Specifies the available modes of how long to remember the account.
@param Default Returns the default mode (to be initially displayed to
the user).
@returns A sequence of available modes to hand back. Each individual
mode should appear at most once in the sequence. If the sequence is
empty, a new mode cannot be handed back.
*/
sequence<com::sun::star::ucb::RememberAuthentication> getRememberAccountModes( [out] com::sun::star::ucb::RememberAuthentication Default );
//-------------------------------------------------------------------------
/** Set a new mode of how long to remember the account.
<p>This method should be called before
<member scope="com::sun::star::task">XInteractionContinuation::select</member>,
and should only be called if
<member>XInteractionSupplyAuthentication::setAccount</member>
is also called.</p>
@param Remember The mode to hand back, should be contained in the
sequence returned by
<member>XInteractionSupplyAuthentication::getRememberAccountModes</member>.
*/
void setRememberAccount( [in] com::sun::star::ucb::RememberAuthentication Remember );
};
//=============================================================================
}; }; }; };
#endif
|
