Back to index

plone3  3.1.7
topic.py
Go to the documentation of this file.
00001 #  ATContentTypes http://plone.org/products/atcontenttypes/
00002 #  Archetypes reimplementation of the CMF core types
00003 #  Copyright (c) 2003-2006 AT Content Types development team
00004 #
00005 #  This program is free software; you can redistribute it and/or modify
00006 #  it under the terms of the GNU General Public License as published by
00007 #  the Free Software Foundation; either version 2 of the License, or
00008 #  (at your option) any later version.
00009 #
00010 #  This program is distributed in the hope that it will be useful,
00011 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
00012 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013 #  GNU General Public License for more details.
00014 #
00015 #  You should have received a copy of the GNU General Public License
00016 #  along with this program; if not, write to the Free Software
00017 #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00018 #
00019 
00020 from Products.ATContentTypes.interface.interfaces import IATContentType
00021 from zope.interface import Interface
00022 from zope.interface import Attribute
00023 
00024 class IATTopic(IATContentType):
00025     """AT Topic marker interface
00026     """
00027 
00028     def listCriteriaTypes():
00029         """List available criteria types as dict
00030         """
00031 
00032     def listCriteriaMetaTypes():
00033         """List available criteria
00034         """
00035 
00036     def listSearchCriteriaTypes():
00037         """List available search criteria types as dict
00038         """
00039 
00040     def listSearchCriteriaMetaTypes():
00041         """List available search criteria
00042         """
00043 
00044     def listSortCriteriaTypes():
00045         """List available sort criteria types as dict
00046         """
00047 
00048     def listSortCriteriaMetaTypes():
00049         """List available sort criteria
00050         """
00051 
00052     def listCriteria():
00053         """Return a list of our criteria objects.
00054         """
00055 
00056     def listSearchCriteria():
00057         """Return a list of our search criteria objects.
00058         """
00059 
00060     def hasSortCriterion():
00061         """Tells if a sort criterai is already setup.
00062         """
00063 
00064     def getSortCriterion():
00065         """Return the Sort criterion if setup.
00066         """
00067 
00068     def removeSortCriterion():
00069         """remove the Sort criterion.
00070         """
00071 
00072     def setSortCriterion(field, reversed):
00073         """Set the Sort criterion.
00074         """
00075 
00076     def listAvailableFields():
00077         """Return a list of available fields for new criteria.
00078         """
00079 
00080     def listSortFields():
00081         """Return a list of available fields for sorting."""
00082 
00083     def listSubtopics():
00084         """Return a list of our subtopics.
00085         """
00086 
00087     def buildQuery():
00088         """Construct a catalog query using our criterion objects.
00089         """
00090 
00091     def queryCatalog(REQUEST=None, **kw):
00092         """Invoke the catalog using our criteria to augment any passed
00093             in query before calling the catalog.
00094         """
00095 
00096     def addCriterion(field, criterion_type):
00097         """Add a new search criterion.
00098         """
00099 
00100     def deleteCriterion(criterion_id):
00101         """Delete selected criterion.
00102         """
00103 
00104     def getCriterion(criterion_id):
00105         """Get the criterion object.
00106         """
00107 
00108     def addSubtopic(id):
00109         """Add a new subtopic.
00110         """
00111 
00112 
00113 class IATTopicCriterion(Interface):
00114     """AT Topic Criterion interface
00115     """
00116 
00117     def widget(field_name, mode="view", field=None, **kwargs):
00118         """redefine widget() to allow seperate field_names from field
00119         """
00120 
00121     def getId():
00122         """get the objects id
00123         """
00124 
00125     def Type():
00126         """
00127         """
00128 
00129     def Description():
00130         """
00131         """
00132 
00133     def getCriteriaItems():
00134         """Return a sequence of items to be used to build the catalog query.
00135         """
00136 
00137 class IATTopicSearchCriterion(IATTopicCriterion):
00138     """Interface for criteria used for searching
00139     """
00140 
00141 class IATTopicSortCriterion(IATTopicCriterion):
00142     """Interface for criteria used for sorting
00143     """
00144 
00145    
00146 class IATCTTopicsTool(Interface):
00147     """Mixin class for providing features to customize the display of topics
00148     """
00149