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

Type ActionHook

object --+
         |
        ActionHook

Known Subclasses:
PostActionHook, PreActionHook

Class representing a 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.

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 and after instance variables are always set to False in this parent class.
Method Summary
  __init__(self, action, command)
Constructor for the ActionHook class.
  __repr__(self)
Official string representation for class instance.
  __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
  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 ActionHook class.
Parameters:
action - Action this hook is associated with
command - Shell command to execute
Raises:
ValueError - If one of the values is invalid.
Overrides:
__builtin__.object.__init__

__repr__(self)
(Representation operator)

Official string representation for class instance.
Overrides:
__builtin__.object.__repr__

__str__(self)
(Informal representation operator)

Informal string representation for class instance.
Overrides:
__builtin__.object.__str__

__cmp__(self, other)
(Comparison operator)

Definition of equals operator for this class.
Parameters:
other - Other object to compare to.
Returns:
-1/0/1 depending on whether self is <, = or > other.

_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. The value must be a non-empty string if it is not None. It must also consist only of lower-case letters and digits.
Raises:
ValueError - If the value is an empty string.

_setCommand(self, value)

Property target used to set the command. The value must be a non-empty string if it is not None.
Raises:
ValueError - If the value is an empty string.

Property Details

action

Action this hook is associated with.
Get Method:
_getAction(self)
Set Method:
_setAction(self, value)

command

Shell command to execute.
Get Method:
_getCommand(self)
Set Method:
_setCommand(self, value)

before

Indicates whether command should be executed before action.
Get Method:
_getBefore(self)

after

Indicates whether command should be executed after action.
Get Method:
_getAfter(self)

Generated by Epydoc 2.1 on Thu Mar 29 20:58:29 2007 http://epydoc.sf.net