Package twisted :: Package coil :: Module coil :: Class ConfigCollection
[frames | no frames]

Class ConfigCollection

Collection --+    
             |    
   Constrained --+
                 |
                ConfigCollection

Known Subclasses:
ConnectorCollection, MailConfigurator, MaildirDBMConfigurator, MimeTypeCollection, PortCollection, Resource, ServiceCollection

A default implementation of IConfigCollection.
Method Summary
  entityConstraint(self, entity)
A method that determines whether an entity may be added to me.
  getEntityType(self)
  getNameType(self)
    Inherited from Constrained
  nameConstraint(self, name)
A method that determines whether an entity may be added to me with a given name.
  putEntity(self, name, entity)
Store an entity if it meets both constraints.
  reallyPutEntity(self, name, entity)
    Inherited from Collection
  __init__(self, entities)
Initialize me.
  delEntity(self, name)
Remove a static reference for 'name'.
  getDynamicEntity(self, name, request)
Subclass this to generate an entity on demand.
  getEntity(self, name, request)
Retrieve an entity from me.
  getStaticEntity(self, name)
Get an entity that was added to me using putEntity.
  listDynamicEntities(self, request)
A list of all name, entity that I can generate on demand.
  listDynamicNames(self)
Retrieve a list of the names of entities that I store references to.
  listEntities(self, request)
Retrieve a list of all name, entity pairs I contain.
  listNames(self, request)
Retrieve a list of all names for entities that I contain.
  listStaticEntities(self)
Retrieve a list of all name, entity pairs that I store references to.
  listStaticNames(self)
Retrieve a list of the names of entities that I store references to.
  removeEntity(self, name, request)
Remove an entity for 'name', based on the content of 'request'.
  storeEntity(self, name, request)
Store an entity for 'name', based on the content of 'request'.

Class Variable Summary
class __implements__ = twisted.coil.coil.IConfigCollection
class entityType = twisted.python.components.Interface

Method Details

entityConstraint(self, entity)

A method that determines whether an entity may be added to me.

If the constraint is satisfied, return 1; if the constraint is not satisfied, either return 0 or raise a descriptive ConstraintViolation.
Overrides:
twisted.python.roots.Constrained.entityConstraint (inherited documentation)

Generated by Epydoc 2.0 on Sat Sep 13 04:20:44 2003 http://epydoc.sf.net