1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
# ATContentTypes http://sf.net/projects/collective/
# Archetypes reimplementation of the CMF core types
# Copyright (c) 2003-2004 AT Content Types development team
#
# 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
#
"""Topic and criterion interface
$Id: IATTopic.py,v 1.7 2004/07/13 13:12:55 dreamcatcher Exp $
"""
__author__ = 'Christian Heimes'
__docformat__ = 'restructuredtext'
from Interface import Interface, Attribute
from Products.ATContentTypes.interfaces.IATContentType import IATContentType
class IATTopic(IATContentType):
"""AT Topic marker interface
"""
def listCriteriaTypes():
"""List available criteria types as dict
"""
def listCriteriaMetaTypes():
"""List available criteria
"""
def listSearchCriteriaTypes():
"""List available search criteria types as dict
"""
def listSearchCriteriaMetaTypes():
"""List available search criteria
"""
def listSortCriteriaTypes():
"""List available sort criteria types as dict
"""
def listSortCriteriaMetaTypes():
"""List available sort criteria
"""
def listCriteria():
"""Return a list of our criteria objects.
"""
def listSearchCriteria():
"""Return a list of our search criteria objects.
"""
def hasSortCriterion():
"""Tells if a sort criterai is already setup.
"""
def getSortCriterion():
"""Return the Sort criterion if setup.
"""
def removeSortCriterion():
"""remove the Sort criterion.
"""
def setSortCriterion(field, reversed):
"""Set the Sort criterion.
"""
def listAvailableFields():
"""Return a list of available fields for new criteria.
"""
def listSubtopics():
"""Return a list of our subtopics.
"""
def buildQuery():
"""Construct a catalog query using our criterion objects.
"""
def queryCatalog(REQUEST=None, **kw):
"""Invoke the catalog using our criteria to augment any passed
in query before calling the catalog.
"""
def addCriterion(field, criterion_type):
"""Add a new search criterion.
"""
def deleteCriterion(criterion_id):
"""Delete selected criterion.
"""
def getCriterion(criterion_id):
"""Get the criterion object.
"""
def addSubtopic(id):
"""Add a new subtopic.
"""
class IATTopicCriterion(Interface):
"""AT Topic Criterion interface
"""
typeDescription = Attribute('''A short description used for the edit screen''')
typeDescMsgId = Attribute('''The i18n msgid of the type description''')
def widget(field_name, mode="view", field=None, **kwargs):
"""redefine widget() to allow seperate field_names from field
"""
def getId():
"""get the objects id
"""
def Type():
"""
"""
def Description():
"""
"""
def getCriteriaItems():
"""Return a sequence of items to be used to build the catalog query.
"""
class IATTopicSearchCriterion(IATTopicCriterion):
"""Interface for criteria used for searching
"""
class IATTopicSortCriterion(IATTopicCriterion):
"""Interface for criteria used for sorting
"""
|
