Back to index

plone3  3.1.7
Public Member Functions
CMFTopic.interfaces.ICriterion Class Reference
Inheritance diagram for CMFTopic.interfaces.ICriterion:
Inheritance graph
[legend]
Collaboration diagram for CMFTopic.interfaces.ICriterion:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def Type
def Field
def Description
def editableAttributes
def getEditForm
def apply

Detailed Description

\
A Topic is composed of Criterion objects which specify the query
used for the Topic.  By supplying some basic information, the
Criterion objects can be plugged into Topics without the Topic
having to be too aware of the Criteria types.

Definition at line 42 of file __init__.py.


Member Function Documentation

\
To make it easier to apply values from the rather dynamic
Criterion edit form using Python Scripts, apply takes a
mapping object as a default and applies itself to self.edit.

It's basically a nice and protected wrapper around
self.edit(**command).

Definition at line 78 of file __init__.py.

00078 
00079     def apply(command):
00080         """\
00081         To make it easier to apply values from the rather dynamic
00082         Criterion edit form using Python Scripts, apply takes a
00083         mapping object as a default and applies itself to self.edit.
00084 
00085         It's basically a nice and protected wrapper around
00086         self.edit(**command).
00087         """
00088 
# XXX: Interfaces have to specify the signature.
\
Return a brief description of the criteria type.

Definition at line 60 of file __init__.py.

00060 
00061     def Description():
00062         """\
00063         Return a brief description of the criteria type.
00064         """

Here is the caller graph for this function:

\
Returns a tuble of editable attributes.  The values of this
are used by the topic to build commands to send to the
'edit' method based on each criterion's setup.

Definition at line 65 of file __init__.py.

00065 
00066     def editableAttributes():
00067         """\
00068         Returns a tuble of editable attributes.  The values of this
00069         are used by the topic to build commands to send to the
00070         'edit' method based on each criterion's setup.
00071         """

\
Return the field this criterion object searches on.

Definition at line 55 of file __init__.py.

00055 
00056     def Field():
00057         """\
00058         Return the field this criterion object searches on.
00059         """

Here is the caller graph for this function:

\
Return the name of a DTML component used to edit criterion.
Editforms should be specific to their type of criteria.

Definition at line 72 of file __init__.py.

00072 
00073     def getEditForm():
00074         """\
00075         Return the name of a DTML component used to edit criterion.
00076         Editforms should be specific to their type of criteria.
00077         """

\
A Topic is composed of Criterion objects which specify the query
used for the Topic.  By supplying some basic information, the
Criterion objects can be plugged into Topics without the Topic
having to be too aware of the Criteria types.
\
Return the type of criterion object this is (ie - 'List Criterion')

Definition at line 50 of file __init__.py.

00050 
00051     def Type():
00052         """\
00053         Return the type of criterion object this is (ie - 'List Criterion')
00054         """


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