OwlCyberSecurity - MANAGER
Edit File: caldavclientlibrary.admin.xmlaccounts.commands.command.Command-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.command.Command</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.command-module.html">Module command</a> :: Class Command </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.command.Command-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class Command</h1><p class="nomargin-top"><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command">source code</a></span></p> <pre class="base-tree"> object --+ | <strong class="uidshort">Command</strong> </pre> <dl><dt>Known Subclasses:</dt> <dd> <ul class="subclass-list"> <li><a href="caldavclientlibrary.admin.xmlaccounts.commands.listrecords.ListRecords-class.html">listrecords.ListRecords</a></li><li>, <a href="caldavclientlibrary.admin.xmlaccounts.commands.addrecord.AddRecord-class.html">addrecord.AddRecord</a></li><li>, <a href="caldavclientlibrary.admin.xmlaccounts.commands.removerecord.RemoveRecord-class.html">removerecord.RemoveRecord</a></li><li>, <a href="caldavclientlibrary.admin.xmlaccounts.commands.changepassword.ChangePassword-class.html">changepassword.ChangePassword</a></li> </ul> </dd></dl> <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.command.Command-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">cmdname</span>, <span class="summary-sig-arg">description</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.command-pysrc.html#Command.__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 name="usage"></a><span class="summary-sig-name">usage</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command.usage">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.command.Command-class.html#allRecordsAllowed" class="summary-sig-name">allRecordsAllowed</a>(<span class="summary-sig-arg">self</span>)</span><br /> Indicates whether a command is able to operate on all record types in addition to individual record types.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command.allRecordsAllowed">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><code>int</code></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.command.Command-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">argv</span>)</span><br /> Execute the command specified by the command line arguments.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command.execute">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><code>list</code></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.command.Command-class.html#getTypeArgument" class="summary-sig-name">getTypeArgument</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">argv</span>)</span><br /> Extract the user specified record type argument from the command line arguments.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command.getTypeArgument">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><a href="caldavclientlibrary.admin.xmlaccounts.recordtypes-module.html" class="link">admin.xmlaccounts.recordtypes</a></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.command.Command-class.html#mapType" class="summary-sig-name">mapType</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">type</span>)</span><br /> Map the specified user record type input to the actual record type identifier.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command.mapType">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="loadAccounts"></a><span class="summary-sig-name">loadAccounts</span>(<span class="summary-sig-arg">self</span>)</span><br /> Load the entire directory from the XML file.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command.loadAccounts">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="writeAccounts"></a><span class="summary-sig-name">writeAccounts</span>(<span class="summary-sig-arg">self</span>)</span><br /> Write the entire directory to the XML file.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command.writeAccounts">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.command.Command-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.command-pysrc.html#Command.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="promptPassword"></a><span class="summary-sig-name">promptPassword</span>(<span class="summary-sig-arg">self</span>)</span><br /> Prompt the user for a password.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command.promptPassword">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="getMemberList"></a><span class="summary-sig-name">getMemberList</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">prompt</span>, <span class="summary-sig-arg">title</span>, <span class="summary-sig-arg">type</span>)</span><br /> Prompt the user for a list of members.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command.getMemberList">source code</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>__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> <!-- ==================== 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 class="sig-arg">cmdname</span>, <span class="sig-arg">description</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command.__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.command-pysrc.html#Command.allRecordsAllowed">source code</a></span> </td> </tr></table> <p>Indicates whether a command is able to operate on all record types in addition to individual record types. Sub-classes should override this if they can handle all record in one go.</p> <dl class="fields"> </dl> </td></tr></table> </div> <a name="execute"></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">execute</span>(<span class="sig-arg">self</span>, <span class="sig-arg">argv</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command.execute">source code</a></span> </td> </tr></table> <p>Execute the command specified by the command line arguments.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>argv</code></strong> (<code>list</code>) - command line arguments.</li> </ul></dd> <dt>Returns: <code>int</code></dt> <dd>1 for success, 0 for failure.</dd> </dl> </td></tr></table> </div> <a name="getTypeArgument"></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">getTypeArgument</span>(<span class="sig-arg">self</span>, <span class="sig-arg">argv</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command.getTypeArgument">source code</a></span> </td> </tr></table> <p>Extract the user specified record type argument from the command line arguments.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>argv</code></strong> (<code>list</code>) - command line arguments.</li> </ul></dd> <dt>Returns: <code>list</code></dt> <dd>the modified arguments (if a record type is found the corresponding argument is removed from the argv passed in).</dd> </dl> </td></tr></table> </div> <a name="mapType"></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">mapType</span>(<span class="sig-arg">self</span>, <span class="sig-arg">type</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.commands.command-pysrc.html#Command.mapType">source code</a></span> </td> </tr></table> <p>Map the specified user record type input to the actual record type identifier.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>type</code></strong> (<code>str</code>) - user input from the command line.</li> </ul></dd> <dt>Returns: <a href="caldavclientlibrary.admin.xmlaccounts.recordtypes-module.html" class="link">admin.xmlaccounts.recordtypes</a></dt> <dd>identifier matching the user input, or <code>None</code> if no match.</dd> </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.command-pysrc.html#Command.doCommand">source code</a></span> </td> </tr></table> <p>Run the command. Sub-classes must implement this.</p> <dl class="fields"> </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>