Back to index

plone3  3.1.7
Public Member Functions | Static Public Attributes
ATContentTypes.interfaces.IATTopic Class Reference
Inheritance diagram for ATContentTypes.interfaces.IATTopic:
Inheritance graph
[legend]
Collaboration diagram for ATContentTypes.interfaces.IATTopic:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def listCriteriaTypes
def listCriteriaMetaTypes
def listSearchCriteriaTypes
def listSearchCriteriaMetaTypes
def listSortCriteriaTypes
def listSortCriteriaMetaTypes
def listCriteria
def listSearchCriteria
def hasSortCriterion
def getSortCriterion
def removeSortCriterion
def setSortCriterion
def listAvailableFields
def listSortFields
def listSubtopics
def buildQuery
def queryCatalog
def addCriterion
def deleteCriterion
def getCriterion
def addSubtopic

Static Public Attributes

tuple default_view = Attribute('''Default view template - used for dynamic view''')
tuple suppl_views = Attribute('''Supplementary views - used for dynamic view''')
tuple assocMimetypes
tuple assocFileExt
tuple cmf_edit_kws

Detailed Description

AT Topic marker interface

Definition at line 262 of file interfaces.py.


Member Function Documentation

def ATContentTypes.interfaces.IATTopic.addCriterion (   field,
  criterion_type 
)
Add a new search criterion.

Definition at line 334 of file interfaces.py.

00334 
00335     def addCriterion(field, criterion_type):
00336         """Add a new search criterion.
00337         """

Add a new subtopic.

Definition at line 346 of file interfaces.py.

00346 
00347     def addSubtopic(id):
00348         """Add a new subtopic.
00349         """
00350 

Construct a catalog query using our criterion objects.

Definition at line 325 of file interfaces.py.

00325 
00326     def buildQuery():
00327         """Construct a catalog query using our criterion objects.
00328         """

Here is the caller graph for this function:

Delete selected criterion.

Definition at line 338 of file interfaces.py.

00338 
00339     def deleteCriterion(criterion_id):
00340         """Delete selected criterion.
00341         """

Get the criterion object.

Definition at line 342 of file interfaces.py.

00342 
00343     def getCriterion(criterion_id):
00344         """Get the criterion object.
00345         """

Return the Sort criterion if setup.

Definition at line 302 of file interfaces.py.

00302 
00303     def getSortCriterion():
00304         """Return the Sort criterion if setup.
00305         """

Tells if a sort criterai is already setup.

Definition at line 298 of file interfaces.py.

00298 
00299     def hasSortCriterion():
00300         """Tells if a sort criterai is already setup.
00301         """

Return a list of available fields for new criteria.

Definition at line 314 of file interfaces.py.

00314 
00315     def listAvailableFields():
00316         """Return a list of available fields for new criteria.
00317         """

Return a list of our criteria objects.

Definition at line 290 of file interfaces.py.

00290 
00291     def listCriteria():
00292         """Return a list of our criteria objects.
00293         """

Here is the caller graph for this function:

List available criteria

Definition at line 270 of file interfaces.py.

00270 
00271     def listCriteriaMetaTypes():
00272         """List available criteria
00273         """

AT Topic marker interface
List available criteria types as dict

Definition at line 266 of file interfaces.py.

00266 
00267     def listCriteriaTypes():
00268         """List available criteria types as dict
00269         """

Return a list of our search criteria objects.

Definition at line 294 of file interfaces.py.

00294 
00295     def listSearchCriteria():
00296         """Return a list of our search criteria objects.
00297         """

List available search criteria

Definition at line 278 of file interfaces.py.

00278 
00279     def listSearchCriteriaMetaTypes():
00280         """List available search criteria
00281         """

List available search criteria types as dict

Definition at line 274 of file interfaces.py.

00274 
00275     def listSearchCriteriaTypes():
00276         """List available search criteria types as dict
00277         """

List available sort criteria

Definition at line 286 of file interfaces.py.

00286 
00287     def listSortCriteriaMetaTypes():
00288         """List available sort criteria
00289         """

List available sort criteria types as dict

Definition at line 282 of file interfaces.py.

00282 
00283     def listSortCriteriaTypes():
00284         """List available sort criteria types as dict
00285         """

Return a list of available fields for sorting.

Definition at line 318 of file interfaces.py.

00318 
00319     def listSortFields():
00320         """Return a list of available fields for sorting."""

Return a list of our subtopics.

Definition at line 321 of file interfaces.py.

00321 
00322     def listSubtopics():
00323         """Return a list of our subtopics.
00324         """

def ATContentTypes.interfaces.IATTopic.queryCatalog (   REQUEST = None,
  kw 
)
Invoke the catalog using our criteria to augment any passed
    in query before calling the catalog.

Definition at line 329 of file interfaces.py.

00329 
00330     def queryCatalog(REQUEST=None, **kw):
00331         """Invoke the catalog using our criteria to augment any passed
00332             in query before calling the catalog.
00333         """

Here is the caller graph for this function:

remove the Sort criterion.

Definition at line 306 of file interfaces.py.

00306 
00307     def removeSortCriterion():
00308         """remove the Sort criterion.
00309         """

def ATContentTypes.interfaces.IATTopic.setSortCriterion (   field,
  reversed 
)
Set the Sort criterion.

Definition at line 310 of file interfaces.py.

00310 
00311     def setSortCriterion(field, reversed):
00312         """Set the Sort criterion.
00313         """


Member Data Documentation

Initial value:
Attribute('''A tuple of file extensions that are associated
                            with this type. Format: ('jpeg', 'png',)
                         ''')

Definition at line 133 of file interfaces.py.

Initial value:
Attribute('''A tuple of mimetypes that are associated
                              with this type. Format: ('bar/foo', 'foo/*',)
                           ''')

Definition at line 129 of file interfaces.py.

Initial value:
Attribute('''List of keyword names.

If one of this kw names is used with edit() then the cmf_edit method is
called.
''')

Definition at line 137 of file interfaces.py.

tuple ATContentTypes.interfaces.IATContentType.default_view = Attribute('''Default view template - used for dynamic view''') [static, inherited]
interface for AT Content Types

Definition at line 124 of file interfaces.py.

tuple ATContentTypes.interfaces.IATContentType.suppl_views = Attribute('''Supplementary views - used for dynamic view''') [static, inherited]

Definition at line 125 of file interfaces.py.


The documentation for this class was generated from the following file: