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

Type PurgeDir

object --+
         |
        PurgeDir


Class representing a Cedar Backup purge directory.

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, absolutePath, retainDays)
Constructor for the PurgeDir 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.
  _getAbsolutePath(self)
Property target used to get the absolute path.
  _getRetainDays(self)
Property target used to get the absolute path.
  _setAbsolutePath(self, value)
Property target used to set the absolute path.
  _setRetainDays(self, value)
Property target used to set the retain days value.
    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
  absolutePath: Absolute path of directory to purge.
  retainDays: Number of days content within directory should be retained.

Method Details

__init__(self, absolutePath=None, retainDays=None)
(Constructor)

Constructor for the PurgeDir class.
Parameters:
absolutePath - Absolute path of the directory to be purged.
retainDays - Number of days content within directory should be retained.
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.

_getAbsolutePath(self)

Property target used to get the absolute path.

_getRetainDays(self)

Property target used to get the absolute path.

_setAbsolutePath(self, value)

Property target used to set the absolute path. The value must be an absolute path if it is not None. It does not have to exist on disk at the time of assignment.
Raises:
ValueError - If the value is not an absolute path.
ValueError - If the value cannot be encoded properly.

_setRetainDays(self, value)

Property target used to set the retain days value. The value must be an integer >= 0.
Raises:
ValueError - If the value is not valid.

Property Details

absolutePath

Absolute path of directory to purge.
Get Method:
_getAbsolutePath(self)
Set Method:
_setAbsolutePath(self, value)

retainDays

Number of days content within directory should be retained.
Get Method:
_getRetainDays(self)
Set Method:
_setRetainDays(self, value)

Generated by Epydoc 2.1 on Mon Sep 4 13:49:33 2006 http://epydoc.sf.net