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

Type ExtensionsConfig

object --+
         |
        ExtensionsConfig


Class representing Cedar Backup extensions configuration.

Extensions configuration is used to specify "extended actions" implemented by code external to Cedar Backup. For instance, a hypothetical third party might write extension code to collect database repository data. If they write a properly-formatted extension function, they can use the extension configuration to map a command-line Cedar Backup action (i.e. "database") to their function.

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:
Method Summary
  __init__(self, actions, orderMode)
Constructor for the ExtensionsConfig 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.
  _getActions(self)
Property target used to get the actions list.
  _getOrderMode(self)
Property target used to get the order mode.
  _setActions(self, value)
Property target used to set the actions list.
  _setOrderMode(self, value)
Property target used to set the order mode.
    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
  orderMode: Order mode for extensions, to control execution ordering.
  actions: List of extended actions.

Method Details

__init__(self, actions=None, orderMode=None)
(Constructor)

Constructor for the ExtensionsConfig class.
Parameters:
actions - List of extended actions
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.

_getActions(self)

Property target used to get the actions list.

_getOrderMode(self)

Property target used to get the order mode.

_setActions(self, value)

Property target used to set the actions list. Either the value must be None or each element must be an ExtendedAction.
Raises:
ValueError - If the value is not a ExtendedAction

_setOrderMode(self, value)

Property target used to set the order mode. The value must be one of VALID_ORDER_MODES.
Raises:
ValueError - If the value is not valid.

Property Details

orderMode

Order mode for extensions, to control execution ordering.
Get Method:
_getOrderMode(self)
Set Method:
_setOrderMode(self, value)

actions

List of extended actions.
Get Method:
_getActions(self)
Set Method:
_setActions(self, value)

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