Class s.i.IDomain(Interface):

Part of spamfighter.interfaces View Source View In Hierarchy

Домен - единица настроек, привязки локальных элементов внутренного устройства СпамоБорца.

Все домены связаны в дерево, начинающееся главным доменом (глобально известным серверу).

Домен представляет из себя набор свойств и значений, при этом если какое-то свойство отсутствует у данного домена, он обращается за ним к домену-предку. Домен позволяет установить у себя произвольные свойства, удалить (перейти на свойства главного домена).

Доступ к доменам ограничивает партнер (IPartner), который обозначает границы пространства доменов, доступных данному пользователю. При каждом запросе кроме указания партнера обязательно указание домена (возможно, поддомена относительно главного домена партнера).

Method parent Получить предка данного домена.
Method name Имя домена (относительно пути).
Method key Ключ домена. Уникальное и постоянное свойство
Method children Получить список "дочерних" доменов.
Method createSubdomain Создать дочерний поддомен.
Method walk "Пройти" по пути от текущего домена.
Method get Получить значение свойства домена.
Method delete Удалить свойство из домена.
Method set Установить значение свойства в домене.
Method list Получить список имён свойств домена.
Method has Есть ли у домена указанное свойство?
def parent(): (source)
Получить предка данного домена.

Если предка нет, будет возвращено None.

Returns (type: IDomain )
def name(): (source)
Имя домена (относительно пути).

Если домен корневой или не содержится в пути, имя может быть None.

Returnsимя домена (type: str )
def key(): (source)
Ключ домена. Уникальное и постоянное свойство каждого домена.
Returnsключ домена (type: str )
def children(): (source)
Получить список "дочерних" доменов.
ReturnsDeferred, результат - хэш (имя домена: домен) (dict(IDomain)) (type: twisted.internet.defer.Deferred )
def createSubdomain(name): (source)
Создать дочерний поддомен.
Parametersnameимя поддомена (type: str )
ReturnsDeferred с созданным поддоменом, IDomain (type: twisted.internet.defer.Deferred )
RaisesDomainDuplicateErrorдва поддомена с одинаковым именем не могут существовать
def walk(path): (source)
"Пройти" по пути от текущего домена.
Parameterspathпуть относительно текущего домена, строка со слэшами (type: str )
ReturnsDeferred, найденный домен (IDomain) (type: twisted.internet.defer.Deferred )
def get(property): (source)
Получить значение свойства домена.

Если текущий домен не содержит информацию о данном свойстве, будет предпринято обращение к предку домена за данным свойством.

Parameterspropertyимя свойства (type: str )
Returnsзначение свойства
def delete(property): (source)
Удалить свойство из домена.

При следующем обращении к свойству оно будет получено через предка домена, т.е. это эквивалентно сбросу на "значение по умолчанию".

Parameterspropertyимя свойства (type: str )
ReturnsDeferred о результате операции (type: twisted.internet.defer.Deferred )
def set(property, value): (source)
Установить значение свойства в домене.

Данный метод может также создать свойство, если оно ранее не существовало и переопределить свойство домена-предка.

Parameterspropertyимя свойства (type: str )
valueзначение свойства
ReturnsDeferred о результате операции (type: twisted.internet.defer.Deferred )
def list(): (source)
Получить список имён свойств домена.
Returnsсписок имён свойств (type: list(str) )
def has(property): (source)
Есть ли у домена указанное свойство?
Parameterspropertyимя свойства (type: str )
Returns (type: bool )
API Documentation for SpamFighter, generated by pydoctor at 2009-02-27 11:58:37.