doc/api/python/ccm.Releasedef-class.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 <?xml version="1.0" encoding="ascii"?>
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3           "DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     5 <head>
       
     6   <title>ccm.Releasedef</title>
       
     7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
       
     8   <script type="text/javascript" src="epydoc.js"></script>
       
     9 </head>
       
    10 
       
    11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
       
    12       alink="#204080">
       
    13 <!-- ==================== NAVIGATION BAR ==================== -->
       
    14 <table class="navbar" border="0" width="100%" cellpadding="0"
       
    15        bgcolor="#a0c0ff" cellspacing="0">
       
    16   <tr valign="middle">
       
    17 
       
    18   <!-- Tree link -->
       
    19       <th>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
    29 
       
    30       <th class="navbar" width="100%"></th>
       
    31   </tr>
       
    32 </table>
       
    33 <table width="100%" cellpadding="0" cellspacing="0">
       
    34   <tr valign="top">
       
    35     <td width="100%">
       
    36       <span class="breadcrumbs">
       
    37         <a href="ccm-module.html">Package&nbsp;ccm</a> ::
       
    38         Class&nbsp;Releasedef
       
    39       </span>
       
    40     </td>
       
    41     <td>
       
    42       <table cellpadding="0" cellspacing="0">
       
    43         <!-- hide/show private -->
       
    44         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    45     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    46         <tr><td align="right"><span class="options"
       
    47             >[<a href="frames.html" target="_top">frames</a
       
    48             >]&nbsp;|&nbsp;<a href="ccm.Releasedef-class.html"
       
    49             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    50       </table>
       
    51     </td>
       
    52   </tr>
       
    53 </table>
       
    54 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    55 <h1 class="epydoc">Class Releasedef</h1><span class="codelink"><a href="ccm-pysrc.html#Releasedef">source&nbsp;code</a></span><br /><br />
       
    56 <pre class="base-tree">
       
    57   object --+        
       
    58            |        
       
    59 <a href="ccm.FourPartName-class.html">FourPartName</a> --+    
       
    60                |    
       
    61        <a href="ccm.CCMObject-class.html">CCMObject</a> --+
       
    62                    |
       
    63                   <strong class="uidshort">Releasedef</strong>
       
    64 </pre>
       
    65 
       
    66 <hr />
       
    67 Wrapper class for Synergy releasedef object<br /><br />
       
    68 
       
    69 <!-- ==================== INSTANCE METHODS ==================== -->
       
    70 <a name="section-InstanceMethods"></a>
       
    71 <table class="summary" border="1" cellpadding="3"
       
    72        cellspacing="0" width="100%" bgcolor="white">
       
    73 <tr bgcolor="#70b0f0" class="table-header">
       
    74   <td colspan="2" class="table-header">
       
    75     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    76       <tr valign="top">
       
    77         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    78         <td align="right" valign="top"
       
    79          ><span class="options">[<a href="#section-InstanceMethods"
       
    80          class="privatelink" onclick="toggle_private();"
       
    81          >hide private</a>]</span></td>
       
    82       </tr>
       
    83     </table>
       
    84   </td>
       
    85 </tr>
       
    86 <tr>
       
    87     <td width="15%" align="right" valign="top" class="summary">
       
    88       <span class="summary-type">&nbsp;</span>
       
    89     </td><td class="summary">
       
    90       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    91         <tr>
       
    92           <td><span class="summary-sig"><a href="ccm.Releasedef-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    93         <span class="summary-sig-arg">session</span>,
       
    94         <span class="summary-sig-arg">fpn</span>)</span><br />
       
    95       Create a FourPartName object based on a ifpn string.</td>
       
    96           <td align="right" valign="top">
       
    97             <span class="codelink"><a href="ccm-pysrc.html#Releasedef.__init__">source&nbsp;code</a></span>
       
    98             
       
    99           </td>
       
   100         </tr>
       
   101       </table>
       
   102       
       
   103     </td>
       
   104   </tr>
       
   105 <tr class="private">
       
   106     <td width="15%" align="right" valign="top" class="summary">
       
   107       <span class="summary-type">&nbsp;</span>
       
   108     </td><td class="summary">
       
   109       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   110         <tr>
       
   111           <td><span class="summary-sig"><a name="_getcomponent"></a><span class="summary-sig-name">_getcomponent</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   112           <td align="right" valign="top">
       
   113             <span class="codelink"><a href="ccm-pysrc.html#Releasedef._getcomponent">source&nbsp;code</a></span>
       
   114             
       
   115           </td>
       
   116         </tr>
       
   117       </table>
       
   118       
       
   119     </td>
       
   120   </tr>
       
   121 <tr>
       
   122     <td width="15%" align="right" valign="top" class="summary">
       
   123       <span class="summary-type">&nbsp;</span>
       
   124     </td><td class="summary">
       
   125       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   126         <tr>
       
   127           <td><span class="summary-sig"><a name="component"></a><span class="summary-sig-name">component</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   128           <td align="right" valign="top">
       
   129             <span class="codelink"><a href="ccm-pysrc.html#Releasedef.component">source&nbsp;code</a></span>
       
   130             
       
   131           </td>
       
   132         </tr>
       
   133       </table>
       
   134       
       
   135     </td>
       
   136   </tr>
       
   137   <tr>
       
   138     <td colspan="2" class="summary">
       
   139     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.CCMObject-class.html">CCMObject</a></code></b>:
       
   140       <code><a href="ccm.CCMObject-class.html#__getitem__">__getitem__</a></code>,
       
   141       <code><a href="ccm.CCMObject-class.html#__setitem__">__setitem__</a></code>,
       
   142       <code><a href="ccm.CCMObject-class.html#create_attribute">create_attribute</a></code>,
       
   143       <code><a href="ccm.CCMObject-class.html#exists">exists</a></code>,
       
   144       <code><a href="ccm.CCMObject-class.html#finduse">finduse</a></code>,
       
   145       <code><a href="ccm.CCMObject-class.html#is_predecessor_of">is_predecessor_of</a></code>,
       
   146       <code><a href="ccm.CCMObject-class.html#is_recursive_predecessor_of">is_recursive_predecessor_of</a></code>,
       
   147       <code><a href="ccm.CCMObject-class.html#is_recursive_predecessor_of_fast">is_recursive_predecessor_of_fast</a></code>,
       
   148       <code><a href="ccm.CCMObject-class.html#is_recursive_successor_of_fast">is_recursive_successor_of_fast</a></code>,
       
   149       <code><a href="ccm.CCMObject-class.html#is_recursive_sucessor_of">is_recursive_sucessor_of</a></code>,
       
   150       <code><a href="ccm.CCMObject-class.html#keys">keys</a></code>,
       
   151       <code><a href="ccm.CCMObject-class.html#predecessors">predecessors</a></code>,
       
   152       <code><a href="ccm.CCMObject-class.html#relate">relate</a></code>,
       
   153       <code><a href="ccm.CCMObject-class.html#session">session</a></code>,
       
   154       <code><a href="ccm.CCMObject-class.html#successors">successors</a></code>
       
   155       </p>
       
   156     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.CCMObject-class.html">CCMObject</a></code></b> (private):
       
   157       <code><a href="ccm.CCMObject-class.html#_getsession">_getsession</a></code>
       
   158       </p></div>
       
   159     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.FourPartName-class.html">FourPartName</a></code></b>:
       
   160       <code><a href="ccm.FourPartName-class.html#__eq__">__eq__</a></code>,
       
   161       <code><a href="ccm.FourPartName-class.html#__ne__">__ne__</a></code>,
       
   162       <code><a href="ccm.FourPartName-class.html#__repr__">__repr__</a></code>,
       
   163       <code><a href="ccm.FourPartName-class.html#__str__">__str__</a></code>,
       
   164       <code><a href="ccm.FourPartName-class.html#family">family</a></code>,
       
   165       <code><a href="ccm.FourPartName-class.html#instance">instance</a></code>,
       
   166       <code><a href="ccm.FourPartName-class.html#is_same_family">is_same_family</a></code>,
       
   167       <code><a href="ccm.FourPartName-class.html#name">name</a></code>,
       
   168       <code><a href="ccm.FourPartName-class.html#objectname">objectname</a></code>,
       
   169       <code><a href="ccm.FourPartName-class.html#type">type</a></code>,
       
   170       <code><a href="ccm.FourPartName-class.html#version">version</a></code>
       
   171       </p>
       
   172     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   173       <code>__delattr__</code>,
       
   174       <code>__getattribute__</code>,
       
   175       <code>__hash__</code>,
       
   176       <code>__new__</code>,
       
   177       <code>__reduce__</code>,
       
   178       <code>__reduce_ex__</code>,
       
   179       <code>__setattr__</code>
       
   180       </p>
       
   181     </td>
       
   182   </tr>
       
   183 </table>
       
   184 <!-- ==================== STATIC METHODS ==================== -->
       
   185 <a name="section-StaticMethods"></a>
       
   186 <table class="summary" border="1" cellpadding="3"
       
   187        cellspacing="0" width="100%" bgcolor="white">
       
   188 <tr bgcolor="#70b0f0" class="table-header">
       
   189   <td colspan="2" class="table-header">
       
   190     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   191       <tr valign="top">
       
   192         <td align="left"><span class="table-header">Static Methods</span></td>
       
   193         <td align="right" valign="top"
       
   194          ><span class="options">[<a href="#section-StaticMethods"
       
   195          class="privatelink" onclick="toggle_private();"
       
   196          >hide private</a>]</span></td>
       
   197       </tr>
       
   198     </table>
       
   199   </td>
       
   200 </tr>
       
   201   <tr>
       
   202     <td colspan="2" class="summary">
       
   203     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.FourPartName-class.html">FourPartName</a></code></b>:
       
   204       <code><a href="ccm.FourPartName-class.html#convert">convert</a></code>,
       
   205       <code><a href="ccm.FourPartName-class.html#is_valid">is_valid</a></code>
       
   206       </p>
       
   207     </td>
       
   208   </tr>
       
   209 </table>
       
   210 <!-- ==================== PROPERTIES ==================== -->
       
   211 <a name="section-Properties"></a>
       
   212 <table class="summary" border="1" cellpadding="3"
       
   213        cellspacing="0" width="100%" bgcolor="white">
       
   214 <tr bgcolor="#70b0f0" class="table-header">
       
   215   <td colspan="2" class="table-header">
       
   216     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   217       <tr valign="top">
       
   218         <td align="left"><span class="table-header">Properties</span></td>
       
   219         <td align="right" valign="top"
       
   220          ><span class="options">[<a href="#section-Properties"
       
   221          class="privatelink" onclick="toggle_private();"
       
   222          >hide private</a>]</span></td>
       
   223       </tr>
       
   224     </table>
       
   225   </td>
       
   226 </tr>
       
   227   <tr>
       
   228     <td colspan="2" class="summary">
       
   229     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   230       <code>__class__</code>
       
   231       </p>
       
   232     </td>
       
   233   </tr>
       
   234 </table>
       
   235 <!-- ==================== METHOD DETAILS ==================== -->
       
   236 <a name="section-MethodDetails"></a>
       
   237 <table class="details" border="1" cellpadding="3"
       
   238        cellspacing="0" width="100%" bgcolor="white">
       
   239 <tr bgcolor="#70b0f0" class="table-header">
       
   240   <td colspan="2" class="table-header">
       
   241     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   242       <tr valign="top">
       
   243         <td align="left"><span class="table-header">Method Details</span></td>
       
   244         <td align="right" valign="top"
       
   245          ><span class="options">[<a href="#section-MethodDetails"
       
   246          class="privatelink" onclick="toggle_private();"
       
   247          >hide private</a>]</span></td>
       
   248       </tr>
       
   249     </table>
       
   250   </td>
       
   251 </tr>
       
   252 </table>
       
   253 <a name="__init__"></a>
       
   254 <div>
       
   255 <table class="details" border="1" cellpadding="3"
       
   256        cellspacing="0" width="100%" bgcolor="white">
       
   257 <tr><td>
       
   258   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   259   <tr valign="top"><td>
       
   260   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   261         <span class="sig-arg">session</span>,
       
   262         <span class="sig-arg">fpn</span>)</span>
       
   263     <br /><em class="fname">(Constructor)</em>
       
   264   </h3>
       
   265   </td><td align="right" valign="top"
       
   266     ><span class="codelink"><a href="ccm-pysrc.html#Releasedef.__init__">source&nbsp;code</a></span>&nbsp;
       
   267     </td>
       
   268   </table>
       
   269   
       
   270   <p>Create a FourPartName object based on a ifpn string.</p>
       
   271 <p>The string have to match the following patterns:
       
   272 - name-version:type:instance
       
   273 - name:version:releasedef:instance
       
   274 - Task database#id
       
   275 - Folder database#id</p>
       
   276 <p>Anything else is considered as old release string format.</p>
       
   277   <dl class="fields">
       
   278     <dt>Overrides:
       
   279       <a href="ccm.CCMObject-class.html#__init__">CCMObject.__init__</a>
       
   280     </dt>
       
   281   </dl>
       
   282 </td></tr></table>
       
   283 </div>
       
   284 <br />
       
   285 <!-- ==================== NAVIGATION BAR ==================== -->
       
   286 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   287        bgcolor="#a0c0ff" cellspacing="0">
       
   288   <tr valign="middle">
       
   289 
       
   290   <!-- Tree link -->
       
   291       <th>&nbsp;&nbsp;&nbsp;<a
       
   292         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   293 
       
   294   <!-- Index link -->
       
   295       <th>&nbsp;&nbsp;&nbsp;<a
       
   296         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   297 
       
   298   <!-- Help link -->
       
   299       <th>&nbsp;&nbsp;&nbsp;<a
       
   300         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   301 
       
   302       <th class="navbar" width="100%"></th>
       
   303   </tr>
       
   304 </table>
       
   305 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   306   <tr>
       
   307     <td align="left" class="footer">
       
   308     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
       
   309     </td>
       
   310     <td align="right" class="footer">
       
   311       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   312     </td>
       
   313   </tr>
       
   314 </table>
       
   315 
       
   316 <script type="text/javascript">
       
   317   <!--
       
   318   // Private objects are initially displayed (because if
       
   319   // javascript is turned off then we want them to be
       
   320   // visible); but by default, we want to hide them.  So hide
       
   321   // them unless we have a cookie that says to show them.
       
   322   checkCookie()
       
   323   // -->
       
   324 </script>
       
   325   
       
   326 </body>
       
   327 </html>