59f012b528
git-svn-id: svn://svn.cy55.de/Zope3/src/cybertools/trunk@1406 fd906abe-77d9-0310-91a1-e0d9ade77398
118 lines
4.8 KiB
Python
118 lines
4.8 KiB
Python
#
|
|
# Copyright (c) 2006 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 typology package.
|
|
|
|
$Id$
|
|
"""
|
|
|
|
from zope.app.container.interfaces import IContainer
|
|
from zope import schema
|
|
from zope.configuration.fields import GlobalObject
|
|
from zope.interface import Interface, Attribute
|
|
from zope.interface.interfaces import IInterface
|
|
|
|
|
|
class IType(Interface):
|
|
""" A collection of informations about a type; may be associated
|
|
with an object (typically as an adapter) specifying the object's
|
|
type.
|
|
"""
|
|
|
|
title = schema.TextLine(title=u'Title',
|
|
description=u'A readable representation',
|
|
required=True)
|
|
token = schema.ASCIILine(title=u'Token',
|
|
description=u'A representation used for identifying a type '
|
|
'temporarily, e.g. on forms',
|
|
required=True)
|
|
tokenForSearch = schema.ASCIILine(title=u'Token for Search',
|
|
description=u'A fairly unique token that may be used '
|
|
'e.g. for identifying types via a catalog index')
|
|
qualifiers = schema.List(title=u'Qualifiers',
|
|
description=u'A set of markers for a simple classifcation of '
|
|
'types, e.g. for selecting with '
|
|
'ITypeManager.listTypes()',
|
|
value_type=schema.ASCIILine())
|
|
typeInterface = schema.Object(IInterface,
|
|
title=u'Interface to Provide',
|
|
description=u'An (optional) interface that objects of this '
|
|
'type can be adapted to and that provides '
|
|
'additional functionality, schema fields, etc')
|
|
factory = schema.Object(Interface,
|
|
title=u'Factory',
|
|
description=u'A factory (or class) that can be used for '
|
|
'creating an object of this type')
|
|
defaultContainer = schema.Object(IContainer,
|
|
title=u'Default Container',
|
|
description=u'Where objects of this type will be created in '
|
|
'when no explicit container is given')
|
|
viewName = schema.ASCIILine(title=u'viewName',
|
|
description=u'Name of the default view to be used for '
|
|
'objects of this type',
|
|
required=False)
|
|
typeProvider = schema.Object(Interface,
|
|
title=u'Type Provider',
|
|
description=u'A usually long-living object that corresponds '
|
|
'to the type. Note that this object need not '
|
|
'provide the IType interface itself but it '
|
|
'should be adaptable to ITypeProvider')
|
|
options = schema.List(title=u'Options',
|
|
description=u'A list of optional settings to be used for '
|
|
'application or environment specific purposes')
|
|
optionsDict = Attribute('The options transformed to a dictionary')
|
|
|
|
# possible extensions:
|
|
# subTypes
|
|
# parentTypes
|
|
|
|
|
|
class ITypeManager(Interface):
|
|
""" A utility or utility-like object (e.g. a container) that may
|
|
manage (store, retrieve, assign) types.
|
|
"""
|
|
|
|
types = schema.Tuple(schema.Object(IType), unique=True,
|
|
title=u'Types',
|
|
description=u'A sequence of type objects managed by '
|
|
'this type manager')
|
|
|
|
def listTypes(**criteria):
|
|
""" Return a sequence of type objects probably restricted via
|
|
a set of query criteria.
|
|
|
|
A simple implementation would use keyword arguments like:
|
|
listTypes(include=('concept',), omit=('system',) where 'concept'
|
|
and 'system' would be elements in the qualifiers attributes
|
|
of the types.
|
|
"""
|
|
|
|
def getType(token):
|
|
""" Return a type object belonging to the token given.
|
|
"""
|
|
|
|
|
|
class ITypeProvider(Interface):
|
|
""" An object (probably used as an adapter) that may provide a
|
|
certain type object.
|
|
"""
|
|
|
|
def getType():
|
|
""" Return the type object this type provider provides.
|
|
"""
|