Back to index

plone3  3.1.7
Public Member Functions
ATContentTypes.interface.topic.IATTopic Class Reference
Inheritance diagram for ATContentTypes.interface.topic.IATTopic:
Inheritance graph
[legend]
Collaboration diagram for ATContentTypes.interface.topic.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

Detailed Description

AT Topic marker interface

Definition at line 24 of file topic.py.


Member Function Documentation

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

Definition at line 96 of file topic.py.

00096 
00097     def addCriterion(field, criterion_type):
00098         """Add a new search criterion.
00099         """

Add a new subtopic.

Definition at line 108 of file topic.py.

00108 
00109     def addSubtopic(id):
00110         """Add a new subtopic.
00111         """
00112 

Construct a catalog query using our criterion objects.

Definition at line 87 of file topic.py.

00087 
00088     def buildQuery():
00089         """Construct a catalog query using our criterion objects.
00090         """

Here is the caller graph for this function:

Delete selected criterion.

Definition at line 100 of file topic.py.

00100 
00101     def deleteCriterion(criterion_id):
00102         """Delete selected criterion.
00103         """

Get the criterion object.

Definition at line 104 of file topic.py.

00104 
00105     def getCriterion(criterion_id):
00106         """Get the criterion object.
00107         """

Return the Sort criterion if setup.

Definition at line 64 of file topic.py.

00064 
00065     def getSortCriterion():
00066         """Return the Sort criterion if setup.
00067         """

Tells if a sort criterai is already setup.

Definition at line 60 of file topic.py.

00060 
00061     def hasSortCriterion():
00062         """Tells if a sort criterai is already setup.
00063         """

Return a list of available fields for new criteria.

Definition at line 76 of file topic.py.

00076 
00077     def listAvailableFields():
00078         """Return a list of available fields for new criteria.
00079         """

Return a list of our criteria objects.

Definition at line 52 of file topic.py.

00052 
00053     def listCriteria():
00054         """Return a list of our criteria objects.
00055         """

Here is the caller graph for this function:

List available criteria

Definition at line 32 of file topic.py.

00032 
00033     def listCriteriaMetaTypes():
00034         """List available criteria
00035         """

AT Topic marker interface
List available criteria types as dict

Definition at line 28 of file topic.py.

00028 
00029     def listCriteriaTypes():
00030         """List available criteria types as dict
00031         """

Return a list of our search criteria objects.

Definition at line 56 of file topic.py.

00056 
00057     def listSearchCriteria():
00058         """Return a list of our search criteria objects.
00059         """

List available search criteria

Definition at line 40 of file topic.py.

00040 
00041     def listSearchCriteriaMetaTypes():
00042         """List available search criteria
00043         """

List available search criteria types as dict

Definition at line 36 of file topic.py.

00036 
00037     def listSearchCriteriaTypes():
00038         """List available search criteria types as dict
00039         """

List available sort criteria

Definition at line 48 of file topic.py.

00048 
00049     def listSortCriteriaMetaTypes():
00050         """List available sort criteria
00051         """

List available sort criteria types as dict

Definition at line 44 of file topic.py.

00044 
00045     def listSortCriteriaTypes():
00046         """List available sort criteria types as dict
00047         """

Return a list of available fields for sorting.

Definition at line 80 of file topic.py.

00080 
00081     def listSortFields():
00082         """Return a list of available fields for sorting."""

Return a list of our subtopics.

Definition at line 83 of file topic.py.

00083 
00084     def listSubtopics():
00085         """Return a list of our subtopics.
00086         """

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

Definition at line 91 of file topic.py.

00091 
00092     def queryCatalog(REQUEST=None, **kw):
00093         """Invoke the catalog using our criteria to augment any passed
00094             in query before calling the catalog.
00095         """

Here is the caller graph for this function:

remove the Sort criterion.

Definition at line 68 of file topic.py.

00068 
00069     def removeSortCriterion():
00070         """remove the Sort criterion.
00071         """

Set the Sort criterion.

Definition at line 72 of file topic.py.

00072 
00073     def setSortCriterion(field, reversed):
00074         """Set the Sort criterion.
00075         """


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