Package CedarBackup2 :: Module config :: Class PreActionHook
[show private | hide private]
[frames | no frames]

Type PreActionHook

object --+    
         |    
ActionHook --+
             |
            PreActionHook


Class representing a pre-action hook associated with an action.

A hook associated with an action is a shell command to be executed either before or after a named action is executed. In this case, a pre-action hook is executed before the named action.

As with all of the other classes that represent configuration sections, all of these values are optional. It is up to some higher-level construct to decide whether everything they need is filled in. Some validation is done on non-None assignments through the use of the Python property() construct.

The following restrictions exist on data in this class: The internal before instance variable is always set to True in this class.
Method Summary
  __init__(self, action, command)
Constructor for the PreActionHook class.
  __repr__(self)
Official string representation for class instance.
    Inherited from ActionHook
  __str__(self)
Informal string representation for class instance.
  __cmp__(self, other)
Definition of equals operator for this class.
  _getAction(self)
Property target used to get the action name.
  _getAfter(self)
Property target used to get the after flag.
  _getBefore(self)
Property target used to get the before flag.
  _getCommand(self)
Property target used to get the command.
  _setAction(self, value)
Property target used to set the action name.
  _setCommand(self, value)
Property target used to set the command.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value

Property Summary
    Inherited from ActionHook
  action: Action this hook is associated with.
  command: Shell command to execute.
  before: Indicates whether command should be executed before action.
  after: Indicates whether command should be executed after action.

Method Details

__init__(self, action=None, command=None)
(Constructor)

Constructor for the PreActionHook class.
Parameters:
action - Action this hook is associated with
command - Shell command to execute
Raises:
ValueError - If one of the values is invalid.
Overrides:
CedarBackup2.config.ActionHook.__init__

__repr__(self)
(Representation operator)

Official string representation for class instance.
Overrides:
CedarBackup2.config.ActionHook.__repr__

Generated by Epydoc 2.1 on Thu Dec 22 20:45:13 2005 http://epydoc.sf.net