paula.proputil/trunk/src/paula/proputil/interfaces.py

   1 # Copyright (c) 2008 by Florian Friesdorf
   2 #
   3 # GNU Affero General Public License (AGPL)
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU Affero General Public License as
   7 # published by the Free Software Foundation; either version 3 of the
   8 # License, or (at your option) any later version.
   9 #
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU Affero General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU Affero General Public
  16 # License along with this program.  If not, see
  17 # <http://www.gnu.org/licenses/>.
  18 """
  19 """
  20 __author__ = "Florian Friesdorf <flo@chaoflow.net>"
  21 __docformat__ = "plaintext"
  22
  23 from zope.interface import Interface
  24
  25 from paula.properties.interfaces import IPropertyProviders
  26
  27
  28 class IPropertyProviderAdaptable(Interface):
  29     """Marker interface for objects that can be adapted to IPropertyProvider
  30     """
  31
  32 class IRWPropertyProviders(IPropertyProviders):
  33     """A utility that returns property providers for principals
  34     """
  35
  36     def register(obj):
  37         """Register an object
  38
  39         It is assumed that the object provides IPropertyProviderAdaptable and
  40         an adapter for IPropertyProvider is available, a TypeError is raised
  41         otherwise.
  42         """
  43
  44     def unregister(obj):
  45         """Unregister an object.
  46
  47         Fails with ValueError, if the object is not registered.
  48         """
  49
  50 class ILocalRWPropertyProviders(IRWPropertyProviders):
  51     """
  52     """