Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 7622

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XInteractionSupplyAuthentication</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XInteractionSupplyAuthentication-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">ucb</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XInteractionSupplyAuthentication</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XInteractionSupplyAuthentication</strong>
&#x2517 ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionContinuation.html">XInteractionContinuation</a>

</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left">::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionContinuation.html">XInteractionContinuation</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>Specifies a way of how to continue from an
 ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionRequest.html">XInteractionRequest</a>.
 </dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>An interaction continuation handing back some authentication data.
 
 </dd>
<dd><p> This continuation is typically used in conjunction with
 <a href="AuthenticationRequest.html">AuthenticationRequest</a>. </p>
</dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#canSetRealm">canSetRealm</a></td>
<td class="imsum_right">Specifies if a new 'realm' value can be handed back.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setRealm">setRealm</a></td>
<td class="imsum_right">Set a new 'realm' value to hand back.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#canSetUserName">canSetUserName</a></td>
<td class="imsum_right">Specifies if a 'user name' value can be handed back.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setUserName">setUserName</a></td>
<td class="imsum_right">Set a new 'user name' value to hand back.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#canSetPassword">canSetPassword</a></td>
<td class="imsum_right">Specifies if a 'password' value can be handed back.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setPassword">setPassword</a></td>
<td class="imsum_right">Set a new 'password' value to hand back.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getRememberPasswordModes">getRememberPasswordModes</a></td>
<td class="imsum_right">Specifies the available modes of how long to remember the password.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setRememberPassword">setRememberPassword</a></td>
<td class="imsum_right">Set a new mode of how long to remember the password.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#canSetAccount">canSetAccount</a></td>
<td class="imsum_right">Specifies if an 'account' value can be handed back.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setAccount">setAccount</a></td>
<td class="imsum_right">Set a new 'account' value to hand back.
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getRememberAccountModes">getRememberAccountModes</a></td>
<td class="imsum_right">Specifies the available modes of how long to remember the account.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setRememberAccount">setRememberAccount</a></td>
<td class="imsum_right">Set a new mode of how long to remember the account.
 
 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="canSetRealm" class="membertitle">canSetRealm</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>canSetRealm</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Specifies if a new 'realm' value can be handed back.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setRealm" class="membertitle">setRealm</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setRealm</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Realm );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set a new 'realm' value to hand back.
 
 </dd>
<dd><p>This method should be called before 
 ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionContinuation.html">XInteractionContinuation</a>::<a href="../task/XInteractionContinuation.html#select">select</a>,
 and should only be called if 
 <a href="XInteractionSupplyAuthentication.html">XInteractionSupplyAuthentication</a>::<a href="XInteractionSupplyAuthentication.html#canSetRealm">canSetRealm</a> returned
 <b>true</b>.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="canSetUserName" class="membertitle">canSetUserName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>canSetUserName</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Specifies if a 'user name' value can be handed back.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setUserName" class="membertitle">setUserName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setUserName</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;UserName );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set a new 'user name' value to hand back.

 </dd>
<dd><p>This method should be called before 
 ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionContinuation.html">XInteractionContinuation</a>::<a href="../task/XInteractionContinuation.html#select">select</a>,
 and should only be called if 
 <a href="XInteractionSupplyAuthentication.html">XInteractionSupplyAuthentication</a>::<a href="XInteractionSupplyAuthentication.html#canSetUserName">canSetUserName</a> 
 returned <b>true</b>.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="canSetPassword" class="membertitle">canSetPassword</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>canSetPassword</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Specifies if a 'password' value can be handed back.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setPassword" class="membertitle">setPassword</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setPassword</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Password );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set a new 'password' value to hand back.
 
 </dd>
<dd><p>This method should be called before 
 ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionContinuation.html">XInteractionContinuation</a>::<a href="../task/XInteractionContinuation.html#select">select</a>,
 and should only be called if 
 <a href="XInteractionSupplyAuthentication.html">XInteractionSupplyAuthentication</a>::<a href="XInteractionSupplyAuthentication.html#canSetPassword">canSetPassword</a> 
 returned <b>true</b>.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getRememberPasswordModes" class="membertitle">getRememberPasswordModes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; <a href="RememberAuthentication.html">RememberAuthentication</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getRememberPasswordModes</b>(</td>
<td valign="top">[out] <a href="RememberAuthentication.html">RememberAuthentication</a></td>
<td valign="bottom">&nbsp;Default );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Specifies the available modes of how long to remember the password.

 </dd>
<dt><b>Parameter Default</b></dt>
<dd>Returns the default mode (to be initially displayed to the user).

 </dd>
<dt><b>Returns</b></dt>
<dd>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.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setRememberPassword" class="membertitle">setRememberPassword</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setRememberPassword</b>(</td>
<td valign="top">[in] <a href="RememberAuthentication.html">RememberAuthentication</a></td>
<td valign="bottom">&nbsp;Remember );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set a new mode of how long to remember the password.

 </dd>
<dd><p>This method should be called before 
 ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionContinuation.html">XInteractionContinuation</a>::<a href="../task/XInteractionContinuation.html#select">select</a>,
 and should only be called if 
 <a href="XInteractionSupplyAuthentication.html">XInteractionSupplyAuthentication</a>::<a href="XInteractionSupplyAuthentication.html#setPassword">setPassword</a> 
 is also called.</p>
 
 </dd>
<dt><b>Parameter Remember</b></dt>
<dd>The mode to hand back, should be contained in the sequence returned by
 <a href="XInteractionSupplyAuthentication.html">XInteractionSupplyAuthentication</a>::<a href="XInteractionSupplyAuthentication.html#getRememberPasswordModes">getRememberPasswordModes</a>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="canSetAccount" class="membertitle">canSetAccount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>canSetAccount</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Specifies if an 'account' value can be handed back.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setAccount" class="membertitle">setAccount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setAccount</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Account );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set a new 'account' value to hand back.
 
 </dd>
<dd><p>This method should be called before 
 ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionContinuation.html">XInteractionContinuation</a>::<a href="../task/XInteractionContinuation.html#select">select</a>,
 and should only be called if 
 <a href="XInteractionSupplyAuthentication.html">XInteractionSupplyAuthentication</a>::<a href="XInteractionSupplyAuthentication.html#canSetAccount">canSetAccount</a> 
 returned <b>true</b>.</p>

 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getRememberAccountModes" class="membertitle">getRememberAccountModes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">sequence&lt; <a href="RememberAuthentication.html">RememberAuthentication</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getRememberAccountModes</b>(</td>
<td valign="top">[out] <a href="RememberAuthentication.html">RememberAuthentication</a></td>
<td valign="bottom">&nbsp;Default );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Specifies the available modes of how long to remember the account.

 </dd>
<dt><b>Parameter Default</b></dt>
<dd>Returns the default mode (to be initially displayed to
 the user).

 </dd>
<dt><b>Returns</b></dt>
<dd>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.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="setRememberAccount" class="membertitle">setRememberAccount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>setRememberAccount</b>(</td>
<td valign="top">[in] <a href="RememberAuthentication.html">RememberAuthentication</a></td>
<td valign="bottom">&nbsp;Remember );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Set a new mode of how long to remember the account.
 
 </dd>
<dd><p>This method should be called before 
 ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionContinuation.html">XInteractionContinuation</a>::<a href="../task/XInteractionContinuation.html#select">select</a>,
 and should only be called if 
 <a href="XInteractionSupplyAuthentication.html">XInteractionSupplyAuthentication</a>::<a href="XInteractionSupplyAuthentication.html#setAccount">setAccount</a> 
 is also called.</p>
 
 </dd>
<dt><b>Parameter Remember</b></dt>
<dd>The mode to hand back, should be contained in the
 sequence returned by 
 <a href="XInteractionSupplyAuthentication.html">XInteractionSupplyAuthentication</a>::<a href="XInteractionSupplyAuthentication.html#getRememberAccountModes">getRememberAccountModes</a>.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>