← Back to branch summary

~ubuntu-branches/ubuntu/lucid/cedar-backup2/lucid

« back to all changes in this revision

Viewing changes to doc/interface/CedarBackup2.cli._ActionItem-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2009-03-29 15:00:28 UTC
  • mfrom: (1.1.10 upstream) (4.1.4 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090329150028-ljhfp6mxplcbmx4i
Tags: 2.19.3-1
* New upstream release.
* Remove references to user manual PDF (no longer shipped).
* Update debian/copyright based on new upstream CREDITS.
* Bump standards version to 3.8.1 (no packaging changes).
* Bump debhelper compatibility to 7, per linitian recommendation.
* Declare a dependency on debhelper (>= 7.0.1) to match compatibility.
* Reference /usr/share/common-licenses/GPL-2 rather than just GPL.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/interface/CedarBackup2.cli._ActionItem-class.html
61
61
  </tr>
62
62
</table>
63
63
<!-- ==================== CLASS DESCRIPTION ==================== -->
64
 
<h1 class="epydoc">Class _ActionItem</h1><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionItem">source&nbsp;code</a></span><br /><br />
 
64
<h1 class="epydoc">Class _ActionItem</h1><p class="nomargin-top"><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionItem">source&nbsp;code</a></span></p>
65
65
<pre class="base-tree">
66
66
object --+
67
67
         |
75
75
  <p>The built-in actions will use only the options and config values.  We 
76
76
  also pass in the config path so that extension modules can re-parse 
77
77
  configuration if they want to, to add in extra information.</p>
78
 
  This class is also where pre-action and post-action hooks are 
 
78
  <p>This class is also where pre-action and post-action hooks are 
79
79
  executed.  An action item is instantiated in terms of optional pre- and 
80
80
  post-action hook objects (config.ActionHook), which are then executed at 
81
 
  the appropriate time (if set).<br /><br />
 
81
  the appropriate time (if set).</p>
82
82
 
83
83
<hr />
84
84
<div class="fields">      <p><strong>Note:</strong>
85
 
        The comparison operators for this class have been implemented to
 
85
        The comparison operators for this class have been implemented to 
86
86
        only compare based on the index and SORT_ORDER value, and ignore 
87
87
        all other values.  This is so that the action set list can be 
88
88
        easily sorted first by type (_ActionItem before _ManagedActionItem)
171
171
    </td><td class="summary">
172
172
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
173
173
        <tr>
174
 
          <td><span class="summary-sig"><a href="CedarBackup2.cli._ActionItem-class.html#_executeAction" class="summary-sig-name">_executeAction</a>(<span class="summary-sig-arg">self</span>,
 
174
          <td><span class="summary-sig"><a href="CedarBackup2.cli._ActionItem-class.html#_executeAction" class="summary-sig-name" onclick="show_private();">_executeAction</a>(<span class="summary-sig-arg">self</span>,
175
175
        <span class="summary-sig-arg">configPath</span>,
176
176
        <span class="summary-sig-arg">options</span>,
177
177
        <span class="summary-sig-arg">config</span>)</span><br />
178
 
      Executes the action, specifically the function associated with the
 
178
      Executes the action, specifically the function associated with the 
179
179
      action.</td>
180
180
          <td align="right" valign="top">
181
181
            <span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionItem._executeAction">source&nbsp;code</a></span>
192
192
    </td><td class="summary">
193
193
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
194
194
        <tr>
195
 
          <td><span class="summary-sig"><a href="CedarBackup2.cli._ActionItem-class.html#_executeHook" class="summary-sig-name">_executeHook</a>(<span class="summary-sig-arg">self</span>,
 
195
          <td><span class="summary-sig"><a href="CedarBackup2.cli._ActionItem-class.html#_executeHook" class="summary-sig-name" onclick="show_private();">_executeHook</a>(<span class="summary-sig-arg">self</span>,
196
196
        <span class="summary-sig-arg">type</span>,
197
197
        <span class="summary-sig-arg">hook</span>)</span><br />
198
198
      Executes a hook command via <a 
310
310
  </td><td align="right" valign="top"
311
311
    ><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionItem.__init__">source&nbsp;code</a></span>&nbsp;
312
312
    </td>
313
 
  </table>
 
313
  </tr></table>
314
314
  
315
315
  <p>Default constructor.</p>
316
 
  It's OK to pass <code>None</code> for <code>index</code>, 
 
316
  <p>It's OK to pass <code>None</code> for <code>index</code>, 
317
317
  <code>preHook</code> or <code>postHook</code>, but not for 
318
 
  <code>name</code>.
 
318
  <code>name</code>.</p>
319
319
  <dl class="fields">
320
320
    <dt>Parameters:</dt>
321
321
    <dd><ul class="nomargin-top">
322
322
        <li><strong class="pname"><code>index</code></strong> - Index of the item (or <code>None</code>).</li>
323
323
        <li><strong class="pname"><code>name</code></strong> - Name of the action that is being executed.</li>
324
 
        <li><strong class="pname"><code>preHook</code></strong> - Pre-action hook in terms of an <code>ActionHook</code> object,
 
324
        <li><strong class="pname"><code>preHook</code></strong> - Pre-action hook in terms of an <code>ActionHook</code> object, or
 
325
          <code>None</code>.</li>
 
326
        <li><strong class="pname"><code>postHook</code></strong> - Post-action hook in terms of an <code>ActionHook</code> object, 
325
327
          or <code>None</code>.</li>
326
 
        <li><strong class="pname"><code>postHook</code></strong> - Post-action hook in terms of an <code>ActionHook</code> 
327
 
          object, or <code>None</code>.</li>
328
328
        <li><strong class="pname"><code>function</code></strong> - Reference to function associated with item.</li>
329
329
    </ul></dd>
330
330
    <dt>Overrides:
331
 
      object.__init__
 
331
        object.__init__
332
332
    </dt>
333
333
  </dl>
334
334
</td></tr></table>
347
347
  </td><td align="right" valign="top"
348
348
    ><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionItem.__cmp__">source&nbsp;code</a></span>&nbsp;
349
349
    </td>
350
 
  </table>
 
350
  </tr></table>
351
351
  
352
 
  Definition of equals operator for this class. The only thing we 
353
 
  compare is the item's index.
 
352
  <p>Definition of equals operator for this class. The only thing we 
 
353
  compare is the item's index.</p>
354
354
  <dl class="fields">
355
355
    <dt>Parameters:</dt>
356
356
    <dd><ul class="nomargin-top">
377
377
  </td><td align="right" valign="top"
378
378
    ><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionItem.executeAction">source&nbsp;code</a></span>&nbsp;
379
379
    </td>
380
 
  </table>
 
380
  </tr></table>
381
381
  
382
382
  <p>Executes the action associated with an item, including hooks.</p>
383
 
  See class notes for more details on how the action is executed.
 
383
  <p>See class notes for more details on how the action is executed.</p>
384
384
  <dl class="fields">
385
385
    <dt>Parameters:</dt>
386
386
    <dd><ul class="nomargin-top">
410
410
  </td><td align="right" valign="top"
411
411
    ><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionItem._executeAction">source&nbsp;code</a></span>&nbsp;
412
412
    </td>
413
 
  </table>
 
413
  </tr></table>
414
414
  
415
 
  Executes the action, specifically the function associated with the 
416
 
  action.
 
415
  <p>Executes the action, specifically the function associated with the 
 
416
  action.</p>
417
417
  <dl class="fields">
418
418
    <dt>Parameters:</dt>
419
419
    <dd><ul class="nomargin-top">
438
438
  </td><td align="right" valign="top"
439
439
    ><span class="codelink"><a href="CedarBackup2.cli-pysrc.html#_ActionItem._executeHook">source&nbsp;code</a></span>&nbsp;
440
440
    </td>
441
 
  </table>
 
441
  </tr></table>
442
442
  
443
 
  Executes a hook command via <a 
 
443
  <p>Executes a hook command via <a 
444
444
  href="CedarBackup2.util-module.html#executeCommand" 
445
 
  class="link">util.executeCommand()</a>.
 
445
  class="link">util.executeCommand()</a>.</p>
446
446
  <dl class="fields">
447
447
    <dt>Parameters:</dt>
448
448
    <dd><ul class="nomargin-top">
484
484
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
485
485
  <tr>
486
486
    <td align="left" class="footer">
487
 
    Generated by Epydoc 3.0beta1 on Sat Nov 15 12:16:55 2008
 
487
    Generated by Epydoc 3.0.1 on Sun Mar 29 14:50:16 2009
488
488
    </td>
489
489
    <td align="right" class="footer">
490
 
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
 
490
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
 
491
        >http://epydoc.sourceforge.net</a>
491
492
    </td>
492
493
  </tr>
493
494
</table>
498
499
  // javascript is turned off then we want them to be
499
500
  // visible); but by default, we want to hide them.  So hide
500
501
  // them unless we have a cookie that says to show them.
501
 
  checkCookie()
 
502
  checkCookie();
502
503
  // -->
503
504
</script>
504
 
  
505
505
</body>
506
506
</html>