cybertools/relation/interfaces.py
helmutm e5fefb456d minor clean-up on doc strings
git-svn-id: svn://svn.cy55.de/Zope3/src/cybertools/trunk@659 fd906abe-77d9-0310-91a1-e0d9ade77398
2005-11-05 14:19:12 +00:00

77 lines
2.2 KiB
Python

#
# Copyright (c) 2005 Helmut Merz helmutm@cy55.de
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
"""
interface definitions for the Relations utility and relation objects.
$Id$
"""
from zope.interface import Interface, Attribute
class IRelationsRegistryUpdate(Interface):
""" Interface for registering and unregistering relations with a
relations registry.
"""
def register(relation):
""" Register the relation given with this registry.
"""
def unregister(relation):
""" Remove the relation given from this registry.
"""
class IRelationsRegistryQuery(Interface):
""" Interface for querying a relations registry.
"""
def query(**kw):
""" Return a sequence of relations that fulfill the criteria given.
Example: rr.queryRelations(first=someObject, second=anotherObject,
relationship=SomeRelationClass)
"""
class IRelationsRegistry(IRelationsRegistryUpdate, IRelationsRegistryQuery):
""" Local utility for registering (cataloguing) and searching relations.
"""
class IRelation(Interface):
""" Base interface for relations.
"""
class IDyadicRelation(IRelation):
""" Relation connecting two objects.
"""
first = Attribute('First object that belongs to the relation.')
second = Attribute('Second object that belongs to the relation.')
class ITriadicRelation(IDyadicRelation):
""" Relation connecting three objects.
"""
third = Attribute('Third object that belongs to the relation.')