← Back to branch summary

~ubuntu-branches/ubuntu/karmic/cedar-backup2/karmic

« back to all changes in this revision

Viewing changes to doc/interface/private/CedarBackup2.config.OptionsConfig-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2005-12-13 16:13:31 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20051213161331-dw0cj6f534u8oxgf
Tags: 2.7.1-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/interface/private/CedarBackup2.config.OptionsConfig-class.html
77
77
    The overrides list must be a list of <code>CommandOverride</code> 
78
78
    objects.
79
79
  </li>
 
80
  <li>
 
81
    The hooks list must be a list of <code>ActionHook</code> 
 
82
    objects.
 
83
  </li>
80
84
</ul>
81
85
<hr/>
82
86
 
92
96
          <span class=summary-sig-arg>backupUser</span>,
93
97
          <span class=summary-sig-arg>backupGroup</span>,
94
98
          <span class=summary-sig-arg>rcpCommand</span>,
95
 
          <span class=summary-sig-arg>overrides</span>)</span></code>
 
99
          <span class=summary-sig-arg>overrides</span>,
 
100
          <span class=summary-sig-arg>hooks</span>)</span></code>
96
101
<br />
97
102
Constructor for the <code>OptionsConfig</code> class.</td></tr>
98
103
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
117
122
<br />
118
123
Property target used to get the backup user.</td></tr>
119
124
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
125
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.config.OptionsConfig-class.html#_getHooks" class="summary-sig-name"><code>_getHooks</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
126
<br />
 
127
Property target used to get the command path hooks list.</td></tr>
 
128
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
120
129
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.config.OptionsConfig-class.html#_getOverrides" class="summary-sig-name"><code>_getOverrides</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
121
130
<br />
122
131
Property target used to get the command path overrides list.</td></tr>
143
152
<br />
144
153
Property target used to set the backup user.</td></tr>
145
154
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
155
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.config.OptionsConfig-class.html#_setHooks" class="summary-sig-name"><code>_setHooks</code></a>(<span class=summary-sig-arg>self</span>,
 
156
          <span class=summary-sig-arg>value</span>)</span></code>
 
157
<br />
 
158
Property target used to set the pre- and post-action hooks list.</td></tr>
 
159
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
146
160
  <td><code><span class="summary-sig"><a href="../private/CedarBackup2.config.OptionsConfig-class.html#_setOverrides" class="summary-sig-name"><code>_setOverrides</code></a>(<span class=summary-sig-arg>self</span>,
147
161
          <span class=summary-sig-arg>value</span>)</span></code>
148
162
<br />
207
221
  <td><b><a href="CedarBackup2.config.OptionsConfig-class.html#backupUser"><code>backupUser</code></a></b>: Effective user that backups should run as.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
208
222
  <td><b><a href="CedarBackup2.config.OptionsConfig-class.html#backupGroup"><code>backupGroup</code></a></b>: Effective group that backups should run as.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
209
223
  <td><b><a href="CedarBackup2.config.OptionsConfig-class.html#rcpCommand"><code>rcpCommand</code></a></b>: Default rcp-compatible copy command for staging.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
210
 
  <td><b><a href="CedarBackup2.config.OptionsConfig-class.html#overrides"><code>overrides</code></a></b>: List of configured command path overrides, if any.</td></tr></table><br />
 
224
  <td><b><a href="CedarBackup2.config.OptionsConfig-class.html#overrides"><code>overrides</code></a></b>: List of configured command path overrides, if any.</td></tr><tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
225
  <td><b><a href="CedarBackup2.config.OptionsConfig-class.html#hooks"><code>hooks</code></a></b>: List of configured pre- and post-action hooks.</td></tr></table><br />
211
226
 
212
227
 
213
228
<!-- =========== START OF METHOD DETAILS =========== -->
224
239
          <span class=sig-arg>backupUser</span>=<span class=sig-default>None</span>,
225
240
          <span class=sig-arg>backupGroup</span>=<span class=sig-default>None</span>,
226
241
          <span class=sig-arg>rcpCommand</span>=<span class=sig-default>None</span>,
227
 
          <span class=sig-arg>overrides</span>=<span class=sig-default>None</span>)</span>
 
242
          <span class=sig-arg>overrides</span>=<span class=sig-default>None</span>,
 
243
          <span class=sig-arg>hooks</span>=<span class=sig-default>None</span>)</span>
228
244
    <br /><i>(Constructor)</i>
229
245
  </h3>
230
246
  Constructor for the <code>OptionsConfig</code> class.
242
258
         Default rcp-compatible copy command for staging.
243
259
      <dd><code><b>overrides</b></code> -
244
260
         List of configured command path overrides, if any.
 
261
      <dd><code><b>hooks</b></code> -
 
262
         List of configured pre- and post-action hooks.
245
263
      </dd>
246
264
    </dl>
247
265
    <dl><dt><b>Raises:</b></dt>
320
338
  </dd></dl>
321
339
</td></tr></table>
322
340
 
 
341
<a name="_getHooks"></a>
 
342
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
343
  <h3><span class="sig"><span class="sig-name">_getHooks</span>(<span class=sig-arg>self</span>)</span>
 
344
  </h3>
 
345
  Property target used to get the command path hooks list.
 
346
  <dl><dt></dt><dd>
 
347
  </dd></dl>
 
348
</td></tr></table>
 
349
 
323
350
<a name="_getOverrides"></a>
324
351
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
325
352
  <h3><span class="sig"><span class="sig-name">_getOverrides</span>(<span class=sig-arg>self</span>)</span>
386
413
  </dd></dl>
387
414
</td></tr></table>
388
415
 
 
416
<a name="_setHooks"></a>
 
417
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
418
  <h3><span class="sig"><span class="sig-name">_setHooks</span>(<span class=sig-arg>self</span>,
 
419
          <span class=sig-arg>value</span>)</span>
 
420
  </h3>
 
421
  Property target used to set the pre- and post-action hooks list. 
 
422
  Either the value must be <code>None</code> or each element must be an 
 
423
  <code>ActionHook</code>.
 
424
  <dl><dt></dt><dd>
 
425
    <dl><dt><b>Raises:</b></dt>
 
426
      <dd><code><b>ValueError</b></code> -
 
427
        If the value is not a <code>CommandOverride</code>
 
428
    </dl>
 
429
  </dd></dl>
 
430
</td></tr></table>
 
431
 
389
432
<a name="_setOverrides"></a>
390
433
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
391
434
  <h3><span class="sig"><span class="sig-name">_setOverrides</span>(<span class=sig-arg>self</span>,
568
611
      </dd>
569
612
    </dl>
570
613
  </dd>
 
614
</dl></td></tr></table><table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
615
 
 
616
<a name="hooks"></a>
 
617
<h3>hooks</h3>
 
618
List of configured pre- and post-action hooks.
 
619
<dl>
 
620
  <dt></dt>
 
621
  <dd>
 
622
    <dl>
 
623
      <dt><b>Get Method:</b></dt>
 
624
      <dd><span class="summary-sig"><a href="../private/CedarBackup2.config.OptionsConfig-class.html#_getHooks" class="summary-sig-name"><code>_getHooks</code></a>(<span class=summary-sig-arg>self</span>)</span>
 
625
      </dd>
 
626
      <dt><b>Set Method:</b></dt>
 
627
      <dd><span class="summary-sig"><a href="../private/CedarBackup2.config.OptionsConfig-class.html#_setHooks" class="summary-sig-name"><code>_setHooks</code></a>(<span class=summary-sig-arg>self</span>,
 
628
          <span class=summary-sig-arg>value</span>)</span>
 
629
      </dd>
 
630
    </dl>
 
631
  </dd>
571
632
</dl></td></tr></table><br />
572
633
 
573
634
 
590
651
 
591
652
<table border="0" cellpadding="0" cellspacing="0" width="100%">
592
653
  <tr>
593
 
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Tue Sep 27 12:44:44 2005</font></td>
 
654
    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Tue Dec 13 16:00:21 2005</font></td>
594
655
    <td align="right"><a href="http://epydoc.sourceforge.net"
595
656
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
596
657
  </tr>