offapi/com/sun/star/ucb/XInteractionSupplyAuthentication.idl

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