Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 4860

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XLibraryContainerPassword</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="XLibraryContainerPassword-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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</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">script</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XLibraryContainerPassword</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Extension of XLibraryContainer to provide password functionality.
 This interface should be implemented together with XLibraryContainer2
 </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="#isLibraryPasswordProtected">isLibraryPasswordProtected</a></td>
<td class="imsum_right">Returns true if the accessed library item is protected
 by a password.

 If a library with the this name doesn't exist a 
 com::sun::star::container::NoSuchElementException is thrown.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isLibraryPasswordVerified">isLibraryPasswordVerified</a></td>
<td class="imsum_right">Returns true if the accessed library item is protected by a 
 password (see isLibraryPasswordProtected) and the password 
 was already verified with verifyLibraryPassword or if an 
 initial password was set with changeLibraryPassword.

 If a library with the this name doesn't exist a
 com::sun::star::container::NoSuchElementException is thrown.

 If the library exists but isn't password protected a
 com::sun::star::lang::IllegalArgumentException is thrown.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#verifyLibraryPassword">verifyLibraryPassword</a></td>
<td class="imsum_right">Verifies the library's password. If the correct password
 was passed, the method returns true and further calls to
 isLibraryPasswordVerified will also return true.

 If a library with the this name doesn't exist a
 com::sun::star::container::NoSuchElementException is thrown.

 If the library exists but isn't password protected a
 com::sun::star::lang::IllegalArgumentException is thrown.

 If the library password is already verified a
 com::sun::star::lang::IllegalArgumentException is thrown.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#changeLibraryPassword">changeLibraryPassword</a></td>
<td class="imsum_right">Changes the library's password. 
 
 If the library wasn't password protected before:
 The OldPassword parameter has to be an empty string. 
 Afterwards calls to isLibraryPasswordProtected and 
 isLibraryPasswordVerified for this library will 
 return true.

 If the library already was password protected:
 The OldPassword parameter has to be set to the 
 previous defined password. If then the NewPassword
 parameter is an empty string the library password
 protection will be disabled afterwards (afterwards
 calls to isLibraryPasswordProtected for this library 
 will return false). If the NewPassword parameter is
 not an empty string it will accepted as the new 
 password for the library.
 
 If a library with the this name doesn't exist but isn't
 com::sun::star::container::NoSuchElementException is thrown.

 If the library exists and is password protected and a 
 wrong OldPassword is passed to the method a
 com::sun::star::lang::IllegalArgumentException is thrown.

 If the library exists and isn't password protected and
 the OldPassword isn't an empty string or the library is
 read only a
 com::sun::star::lang::IllegalArgumentException is thrown.
 &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="isLibraryPasswordProtected" class="membertitle">isLibraryPasswordProtected</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>isLibraryPasswordProtected</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Name )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns true if the accessed library item is protected
 by a password.

 If a library with the this name doesn't exist a 
 com::sun::star::container::NoSuchElementException is thrown.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isLibraryPasswordVerified" class="membertitle">isLibraryPasswordVerified</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>isLibraryPasswordVerified</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Name )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Returns true if the accessed library item is protected by a 
 password (see isLibraryPasswordProtected) and the password 
 was already verified with verifyLibraryPassword or if an 
 initial password was set with changeLibraryPassword.

 If a library with the this name doesn't exist a
 com::sun::star::container::NoSuchElementException is thrown.

 If the library exists but isn't password protected a
 com::sun::star::lang::IllegalArgumentException is thrown.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="verifyLibraryPassword" class="membertitle">verifyLibraryPassword</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>verifyLibraryPassword</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Name,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Password )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Verifies the library's password. If the correct password
 was passed, the method returns true and further calls to
 isLibraryPasswordVerified will also return true.

 If a library with the this name doesn't exist a
 com::sun::star::container::NoSuchElementException is thrown.

 If the library exists but isn't password protected a
 com::sun::star::lang::IllegalArgumentException is thrown.

 If the library password is already verified a
 com::sun::star::lang::IllegalArgumentException is thrown.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="changeLibraryPassword" class="membertitle">changeLibraryPassword</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>changeLibraryPassword</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;Name,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;OldPassword,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;NewPassword )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br>
::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/NoSuchElementException.html">NoSuchElementException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Changes the library's password. 
 
 If the library wasn't password protected before:
 The OldPassword parameter has to be an empty string. 
 Afterwards calls to isLibraryPasswordProtected and 
 isLibraryPasswordVerified for this library will 
 return true.

 If the library already was password protected:
 The OldPassword parameter has to be set to the 
 previous defined password. If then the NewPassword
 parameter is an empty string the library password
 protection will be disabled afterwards (afterwards
 calls to isLibraryPasswordProtected for this library 
 will return false). If the NewPassword parameter is
 not an empty string it will accepted as the new 
 password for the library.
 
 If a library with the this name doesn't exist but isn't
 com::sun::star::container::NoSuchElementException is thrown.

 If the library exists and is password protected and a 
 wrong OldPassword is passed to the method a
 com::sun::star::lang::IllegalArgumentException is thrown.

 If the library exists and isn't password protected and
 the OldPassword isn't an empty string or the library is
 read only a
 com::sun::star::lang::IllegalArgumentException is thrown.
 </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; 2008 Sun Microsystems, Inc.</p>

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

</html>