| author | Simon Howkins <simonh@symbian.org> |
| Wed, 11 Nov 2009 14:55:58 +0000 | |
| changeset 754 | 79bd241158d3 |
| parent 432 | f2ddfa555b0f |
| permissions | -rw-r--r-- |
<?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>ccm.Task</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"> <!-- 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="ccm-module.html">Package ccm</a> :: Class Task </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="ccm.Task-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class Task</h1><span class="codelink"><a href="ccm-pysrc.html#Task">source code</a></span><br /><br /> <pre class="base-tree"> object --+ | <a href="ccm.FourPartName-class.html">FourPartName</a> --+ | <a href="ccm.CCMObject-class.html">CCMObject</a> --+ | <strong class="uidshort">Task</strong> </pre> <hr /> Wrapper class for Synergy task object<br /><br /> <!-- ==================== 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="ccm.Task-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">session</span>, <span class="summary-sig-arg">fpn</span>)</span><br /> Create a FourPartName object based on a ifpn string.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Task.__init__">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <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="_getobjects"></a><span class="summary-sig-name">_getobjects</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Task._getobjects">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="append"></a><span class="summary-sig-name">append</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">ccm_object</span>)</span><br /> Associate an object to a task</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Task.append">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="assign"></a><span class="summary-sig-name">assign</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">username</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Task.assign">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <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="_getsynopsis"></a><span class="summary-sig-name">_getsynopsis</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Task._getsynopsis">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="objects"></a><span class="summary-sig-name">objects</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Task.objects">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="__unicode__"></a><span class="summary-sig-name">__unicode__</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Task.__unicode__">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="ccm.Task-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br /> Returns the string representation of the object.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Task.__str__">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="ccm.Task-class.html#get_release_tag" class="summary-sig-name">get_release_tag</a>(<span class="summary-sig-arg">self</span>)</span><br /> Get task release.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Task.get_release_tag">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="ccm.Task-class.html#set_release_tag" class="summary-sig-name">set_release_tag</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">release_tag</span>)</span><br /> Set task release.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Task.set_release_tag">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="ccm.CCMObject-class.html">CCMObject</a></code></b>: <code><a href="ccm.CCMObject-class.html#__getitem__">__getitem__</a></code>, <code><a href="ccm.CCMObject-class.html#__setitem__">__setitem__</a></code>, <code><a href="ccm.CCMObject-class.html#create_attribute">create_attribute</a></code>, <code><a href="ccm.CCMObject-class.html#exists">exists</a></code>, <code><a href="ccm.CCMObject-class.html#finduse">finduse</a></code>, <code><a href="ccm.CCMObject-class.html#is_predecessor_of">is_predecessor_of</a></code>, <code><a href="ccm.CCMObject-class.html#is_recursive_predecessor_of">is_recursive_predecessor_of</a></code>, <code><a href="ccm.CCMObject-class.html#is_recursive_predecessor_of_fast">is_recursive_predecessor_of_fast</a></code>, <code><a href="ccm.CCMObject-class.html#is_recursive_successor_of_fast">is_recursive_successor_of_fast</a></code>, <code><a href="ccm.CCMObject-class.html#is_recursive_sucessor_of">is_recursive_sucessor_of</a></code>, <code><a href="ccm.CCMObject-class.html#keys">keys</a></code>, <code><a href="ccm.CCMObject-class.html#predecessors">predecessors</a></code>, <code><a href="ccm.CCMObject-class.html#relate">relate</a></code>, <code><a href="ccm.CCMObject-class.html#session">session</a></code>, <code><a href="ccm.CCMObject-class.html#successors">successors</a></code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.CCMObject-class.html">CCMObject</a></code></b> (private): <code><a href="ccm.CCMObject-class.html#_getsession">_getsession</a></code> </p></div> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.FourPartName-class.html">FourPartName</a></code></b>: <code><a href="ccm.FourPartName-class.html#__eq__">__eq__</a></code>, <code><a href="ccm.FourPartName-class.html#__ne__">__ne__</a></code>, <code><a href="ccm.FourPartName-class.html#__repr__">__repr__</a></code>, <code><a href="ccm.FourPartName-class.html#family">family</a></code>, <code><a href="ccm.FourPartName-class.html#instance">instance</a></code>, <code><a href="ccm.FourPartName-class.html#is_same_family">is_same_family</a></code>, <code><a href="ccm.FourPartName-class.html#name">name</a></code>, <code><a href="ccm.FourPartName-class.html#objectname">objectname</a></code>, <code><a href="ccm.FourPartName-class.html#type">type</a></code>, <code><a href="ccm.FourPartName-class.html#version">version</a></code> </p> <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: <code>__delattr__</code>, <code>__getattribute__</code>, <code>__hash__</code>, <code>__new__</code>, <code>__reduce__</code>, <code>__reduce_ex__</code>, <code>__setattr__</code> </p> </td> </tr> </table> <!-- ==================== STATIC METHODS ==================== --> <a name="section-StaticMethods"></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">Static Methods</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-StaticMethods" 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 name="create"></a><span class="summary-sig-name">create</span>(<span class="summary-sig-arg">session</span>, <span class="summary-sig-arg">release_tag</span>, <span class="summary-sig-arg">synopsis</span>=<span class="summary-sig-default">""</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Task.create">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="ccm.FourPartName-class.html">FourPartName</a></code></b>: <code><a href="ccm.FourPartName-class.html#convert">convert</a></code>, <code><a href="ccm.FourPartName-class.html#is_valid">is_valid</a></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="release"></a><span class="summary-name">release</span> = <code title="property(get_release_tag, set_release_tag)">property(get_release_tag, set_release_tag)</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 class="sig-arg">session</span>, <span class="sig-arg">fpn</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="ccm-pysrc.html#Task.__init__">source code</a></span> </td> </table> <p>Create a FourPartName object based on a ifpn string.</p> <p>The string have to match the following patterns: - name-version:type:instance - name:version:releasedef:instance - Task database#id - Folder database#id</p> <p>Anything else is considered as old release string format.</p> <dl class="fields"> <dt>Overrides: <a href="ccm.CCMObject-class.html#__init__">CCMObject.__init__</a> </dt> </dl> </td></tr></table> </div> <a name="__str__"></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">__str__</span>(<span class="sig-arg">self</span>)</span> <br /><em class="fname">(Informal representation operator)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="ccm-pysrc.html#Task.__str__">source code</a></span> </td> </table> Returns the string representation of the object. <dl class="fields"> <dt>Overrides: <a href="ccm.FourPartName-class.html#__str__">FourPartName.__str__</a> <dd><em class="note">(inherited documentation)</em></dd> </dt> </dl> </td></tr></table> </div> <a name="get_release_tag"></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">get_release_tag</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="ccm-pysrc.html#Task.get_release_tag">source code</a></span> </td> </table> Get task release. Use release property! <dl class="fields"> </dl> </td></tr></table> </div> <a name="set_release_tag"></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">set_release_tag</span>(<span class="sig-arg">self</span>, <span class="sig-arg">release_tag</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="ccm-pysrc.html#Task.set_release_tag">source code</a></span> </td> </table> Set task release. Use release property! <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"> <!-- 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.0beta1 on Wed Sep 09 13:44:18 2009 </td> <td align="right" class="footer"> <a 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>