OwlCyberSecurity - MANAGER
Edit File: caldavclientlibrary.admin.xmlaccounts.directory.XMLDirectory-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.directory.XMLDirectory</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.directory-module.html">Module directory</a> :: Class XMLDirectory </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.directory.XMLDirectory-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class XMLDirectory</h1><p class="nomargin-top"><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory">source code</a></span></p> <pre class="base-tree"> object --+ | <strong class="uidshort">XMLDirectory</strong> </pre> <hr /> <p>Model object for the XML-based directory. This can parse and generate the full XML file.</p> <!-- ==================== 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.directory.XMLDirectory-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.directory-pysrc.html#XMLDirectory.__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.directory.XMLDirectory-class.html#addRecord" class="summary-sig-name">addRecord</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">record</span>)</span><br /> Add a new principal record to the directory.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.addRecord">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><code>boolean</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.directory.XMLDirectory-class.html#containsRecord" class="summary-sig-name">containsRecord</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">recordType</span>, <span class="summary-sig-arg">uid</span>)</span><br /> Test whether the directory contains a record of the specified type and user id.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.containsRecord">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><code>boolean</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.directory.XMLDirectory-class.html#containsGUID" class="summary-sig-name">containsGUID</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">guid</span>)</span><br /> Test whether the directory contains a record with the specified GUID.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.containsGUID">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.record.XMLRecord-class.html" class="link">admin.xmlaccounts.record.XMLRecord</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.directory.XMLDirectory-class.html#getRecord" class="summary-sig-name">getRecord</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">recordType</span>, <span class="summary-sig-arg">uid</span>)</span><br /> Return the record in the directory with the matching record type and user id.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.getRecord">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><code>boolean</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.directory.XMLDirectory-class.html#removeRecord" class="summary-sig-name">removeRecord</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">recordType</span>, <span class="summary-sig-arg">uid</span>)</span><br /> Remove the record with the matching type and user id from the directory.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.removeRecord">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.directory.XMLDirectory-class.html#parseXML" class="summary-sig-name">parseXML</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">node</span>)</span><br /> Parse an entire XML directory.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.parseXML">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"><code>xml.etree.ElementTree.Element</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.directory.XMLDirectory-class.html#writeXML" class="summary-sig-name">writeXML</a>(<span class="summary-sig-arg">self</span>)</span><br /> Generate an entire XML directory.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.writeXML">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.directory.XMLDirectory-class.html#writeXMLRecords" class="summary-sig-name">writeXMLRecords</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">root</span>, <span class="summary-sig-arg">records</span>)</span><br /> Generate the XML for all records in the specified list.</td> <td align="right" valign="top"> <span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.writeXMLRecords">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> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.__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="addRecord"></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">addRecord</span>(<span class="sig-arg">self</span>, <span class="sig-arg">record</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.addRecord">source code</a></span> </td> </tr></table> <p>Add a new principal record to the directory.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>record</code></strong> (<a href="caldavclientlibrary.admin.xmlaccounts.record.XMLRecord-class.html" class="link">admin.xmlaccounts.record.XMLRecord</a>) - the record to add.</li> </ul></dd> </dl> </td></tr></table> </div> <a name="containsRecord"></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">containsRecord</span>(<span class="sig-arg">self</span>, <span class="sig-arg">recordType</span>, <span class="sig-arg">uid</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.containsRecord">source code</a></span> </td> </tr></table> <p>Test whether the directory contains a record of the specified type and user id.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>recordType</code></strong> (one of <a href="caldavclientlibrary.admin.xmlaccounts.recordtypes-module.html#RECORD_TYPES" class="link">admin.xmlaccounts.recordtypes.RECORD_TYPES</a>) - a principal record type.</li> <li><strong class="pname"><code>uid</code></strong> (<code>str</code>) - the user id to check.</li> </ul></dd> <dt>Returns: <code>boolean</code></dt> <dd><code>True</code> if present in the directory, <code>False</code> otherwise.</dd> </dl> </td></tr></table> </div> <a name="containsGUID"></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">containsGUID</span>(<span class="sig-arg">self</span>, <span class="sig-arg">guid</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.containsGUID">source code</a></span> </td> </tr></table> <p>Test whether the directory contains a record with the specified GUID.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>guid</code></strong> (<code>str</code>) - the GUID to check.</li> </ul></dd> <dt>Returns: <code>boolean</code></dt> <dd><code>True</code> if present in the directory, <code>False</code> otherwise.</dd> </dl> </td></tr></table> </div> <a name="getRecord"></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">getRecord</span>(<span class="sig-arg">self</span>, <span class="sig-arg">recordType</span>, <span class="sig-arg">uid</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.getRecord">source code</a></span> </td> </tr></table> <p>Return the record in the directory with the matching record type and user id.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>recordType</code></strong> (one of <a href="caldavclientlibrary.admin.xmlaccounts.recordtypes-module.html#RECORD_TYPES" class="link">admin.xmlaccounts.recordtypes.RECORD_TYPES</a>) - a principal record type.</li> <li><strong class="pname"><code>uid</code></strong> (<code>str</code>) - the user id to check.</li> </ul></dd> <dt>Returns: <a href="caldavclientlibrary.admin.xmlaccounts.record.XMLRecord-class.html" class="link">admin.xmlaccounts.record.XMLRecord</a></dt> <dd>the matching record, or <code>None</code> if not found.</dd> </dl> </td></tr></table> </div> <a name="removeRecord"></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">removeRecord</span>(<span class="sig-arg">self</span>, <span class="sig-arg">recordType</span>, <span class="sig-arg">uid</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.removeRecord">source code</a></span> </td> </tr></table> <p>Remove the record with the matching type and user id from the directory.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>recordType</code></strong> (one of <a href="caldavclientlibrary.admin.xmlaccounts.recordtypes-module.html#RECORD_TYPES" class="link">admin.xmlaccounts.recordtypes.RECORD_TYPES</a>) - a principal record type.</li> <li><strong class="pname"><code>uid</code></strong> (<code>str</code>) - the user id to remove.</li> </ul></dd> <dt>Returns: <code>boolean</code></dt> <dd><code>True</code> if found and removed, <code>False</code> otherwise.</dd> </dl> </td></tr></table> </div> <a name="parseXML"></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">parseXML</span>(<span class="sig-arg">self</span>, <span class="sig-arg">node</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.parseXML">source code</a></span> </td> </tr></table> <p>Parse an entire XML directory.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>node</code></strong> (<code>xml.etree.ElementTree.Element</code>) - the XML element for the root of the directory file.</li> </ul></dd> </dl> </td></tr></table> </div> <a name="writeXML"></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">writeXML</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.writeXML">source code</a></span> </td> </tr></table> <p>Generate an entire XML directory.</p> <dl class="fields"> <dt>Returns: <code>xml.etree.ElementTree.Element</code></dt> <dd>the root element for the principal record.</dd> </dl> </td></tr></table> </div> <a name="writeXMLRecords"></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">writeXMLRecords</span>(<span class="sig-arg">self</span>, <span class="sig-arg">root</span>, <span class="sig-arg">records</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="caldavclientlibrary.admin.xmlaccounts.directory-pysrc.html#XMLDirectory.writeXMLRecords">source code</a></span> </td> </tr></table> <p>Generate the XML for all records in the specified list.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>root</code></strong> (<code>xml.etree.ElementTree.Element</code>) - the XML root element for the directory.</li> <li><strong class="pname"><code>records</code></strong> (<code>list</code>) - a list of <a href="caldavclientlibrary.admin.xmlaccounts.record.XMLRecord-class.html" class="link">admin.xmlaccounts.record.XMLRecord</a> to process.</li> </ul></dd> </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>