OwlCyberSecurity - MANAGER
Edit File: caldavclientlibrary.admin.xmlaccounts.commands.listrecords.ListRecords-class.html
<?xml version="1.0" encoding="ascii"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <title>caldavclientlibrary.admin.xmlaccounts.commands.listrecords.ListRecords</title> <link rel="stylesheet" href="epydoc.css" type="text/css" /> <script type="text/javascript" src="epydoc.js"></script> </head> <body bgcolor="white" text="black" link="blue" vlink="#204080" alink="#204080"> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="caldavclientlibrary-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <th class="navbar" width="100%"></th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> <a href="caldavclientlibrary-module.html">Package caldavclientlibrary</a> :: <a href="caldavclientlibrary.admin-module.html">Package admin</a> :: <a href="caldavclientlibrary.admin.xmlaccounts-module.html">Package xmlaccounts</a> :: <a href="caldavclientlibrary.admin.xmlaccounts.commands-module.html">Package commands</a> :: <a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords-module.html">Module listrecords</a> :: Class ListRecords </span> </td> <td> <table cellpadding="0" cellspacing="0"> <!-- hide/show private --> <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" onclick="toggle_private();">hide private</a>]</span></td></tr> <tr><td align="right"><span class="options" >[<a href="frames.html" target="_top">frames</a >] | <a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords.ListRecords-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class ListRecords</h1><p class="nomargin-top"><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords-pysrc.html#ListRecords">source code</a></span></p> <pre class="base-tree"> object --+ | <a href="caldavclientlibrary.admin.xmlaccounts.commands.command.Command-class.html">command.Command</a> --+ | <strong class="uidshort">ListRecords</strong> </pre> <hr /> <!-- ==================== INSTANCE METHODS ==================== --> <a name="section-InstanceMethods"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Instance Methods</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-InstanceMethods" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords.ListRecords-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br /> x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords-pysrc.html#ListRecords.__init__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords.ListRecords-class.html#allRecordsAllowed" class="summary-sig-name">allRecordsAllowed</a>(<span class="summary-sig-arg">self</span>)</span><br /> Indicate that this command can list all records in one go as well as each individual record type.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords-pysrc.html#ListRecords.allRecordsAllowed">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords.ListRecords-class.html#doCommand" class="summary-sig-name">doCommand</a>(<span class="summary-sig-arg">self</span>)</span><br /> Run the command.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords-pysrc.html#ListRecords.doCommand">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="listRecords"></a><span class="summary-sig-name">listRecords</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">recordType</span>)</span><br /> Lists records of the specified record type from the directory.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords-pysrc.html#ListRecords.listRecords">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="printTable"></a><span class="summary-sig-name">printTable</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">table</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords-pysrc.html#ListRecords.printTable">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="printDivider"></a><span class="summary-sig-name">printDivider</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">maxWidths</span>, <span class="summary-sig-arg">intermediate</span>=<span class="summary-sig-default">True</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords-pysrc.html#ListRecords.printDivider">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="caldavclientlibrary.admin.xmlaccounts.commands.command.Command-class.html">command.Command</a></code></b>: <code><a href="caldavclientlibrary.admin.xmlaccounts.commands.command.Command-class.html#execute">execute</a></code>, <code><a href="caldavclientlibrary.admin.xmlaccounts.commands.command.Command-class.html#getMemberList">getMemberList</a></code>, <code><a href="caldavclientlibrary.admin.xmlaccounts.commands.command.Command-class.html#getTypeArgument">getTypeArgument</a></code>, <code><a href="caldavclientlibrary.admin.xmlaccounts.commands.command.Command-class.html#loadAccounts">loadAccounts</a></code>, <code><a href="caldavclientlibrary.admin.xmlaccounts.commands.command.Command-class.html#mapType">mapType</a></code>, <code><a href="caldavclientlibrary.admin.xmlaccounts.commands.command.Command-class.html#promptPassword">promptPassword</a></code>, <code><a href="caldavclientlibrary.admin.xmlaccounts.commands.command.Command-class.html#usage">usage</a></code>, <code><a href="caldavclientlibrary.admin.xmlaccounts.commands.command.Command-class.html#writeAccounts">writeAccounts</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__delattr__</code>, <code>__format__</code>, <code>__getattribute__</code>, <code>__hash__</code>, <code>__new__</code>, <code>__reduce__</code>, <code>__reduce_ex__</code>, <code>__repr__</code>, <code>__setattr__</code>, <code>__sizeof__</code>, <code>__str__</code>, <code>__subclasshook__</code> </p> </td> </tr> </table> <!-- ==================== CLASS VARIABLES ==================== --> <a name="section-ClassVariables"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Class Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-ClassVariables" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="CMDNAME"></a><span class="summary-name">CMDNAME</span> = <code title="'list'"><code class="variable-quote">'</code><code class="variable-string">list</code><code class="variable-quote">'</code></code> </td> </tr> </table> <!-- ==================== PROPERTIES ==================== --> <a name="section-Properties"></a> <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Properties</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-Properties" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> <tr> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__class__</code> </p> </td> </tr> </table> <!-- ==================== METHOD DETAILS ==================== --> <a name="section-MethodDetails"></a> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr bgcolor="#70b0f0" class="table-header"> <td colspan="2" class="table-header"> <table border="0" cellpadding="0" cellspacing="0" width="100%"> <tr valign="top"> <td align="left"><span class="table-header">Method Details</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-MethodDetails" class="privatelink" onclick="toggle_private();" >hide private</a>]</span></td> </tr> </table> </td> </tr> </table> <a name="__init__"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords-pysrc.html#ListRecords.__init__">source code</a></span> </td> </tr></table> <p>x.__init__(...) initializes x; see x.__class__.__doc__ for signature</p> <dl class="fields"> <dt>Overrides: object.__init__ <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="allRecordsAllowed"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">allRecordsAllowed</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords-pysrc.html#ListRecords.allRecordsAllowed">source code</a></span> </td> </tr></table> <p>Indicate that this command can list all records in one go as well as each individual record type.</p> <dl class="fields"> <dt>Overrides: <a href="caldavclientlibrary.admin.xmlaccounts.commands.command.Command-class.html#allRecordsAllowed">command.Command.allRecordsAllowed</a> </dt> </dl> </td></tr></table> </div> <a name="doCommand"></a> <div> <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> <tr><td> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr valign="top"><td> <h3 class="epydoc"><span class="sig"><span class="sig-name">doCommand</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords-pysrc.html#ListRecords.doCommand">source code</a></span> </td> </tr></table> <p>Run the command.</p> <dl class="fields"> <dt>Overrides: <a href="caldavclientlibrary.admin.xmlaccounts.commands.command.Command-class.html#doCommand">command.Command.doCommand</a> </dt> </dl> </td></tr></table> </div> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Home link --> <th> <a href="caldavclientlibrary-module.html">Home</a> </th> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <th class="navbar" width="100%"></th> </tr> </table> <table border="0" cellpadding="0" cellspacing="0" width="100%%"> <tr> <td align="left" class="footer"> Generated by Epydoc 3.0.1 on Thu Jul 7 15:01:45 2011 </td> <td align="right" class="footer"> <a target="mainFrame" href="http://epydoc.sourceforge.net" >http://epydoc.sourceforge.net</a> </td> </tr> </table> <script type="text/javascript"> <!-- // Private objects are initially displayed (because if // javascript is turned off then we want them to be // visible); but by default, we want to hide them. So hide // them unless we have a cookie that says to show them. checkCookie(); // --> </script> </body> </html>