Back to index

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

List of all members.

Public Member Functions

def apply
def editableAttributes
def Type
def Field
def Description

Static Public Attributes

tuple security = ClassSecurityInfo()

Detailed Description

    Abstract base class for Criterion objects.

Definition at line 27 of file AbstractCriterion.py.


Member Function Documentation

    Apply 'command', which is expected to be a dictionary,
    to 'self.edit' (makes using Python Scripts easier).

Definition at line 35 of file AbstractCriterion.py.

00035 
00036     def apply( self, command ):
00037         """
00038             Apply 'command', which is expected to be a dictionary,
00039             to 'self.edit' (makes using Python Scripts easier).
00040         """
00041         self.edit(**command)

Here is the call graph for this function:

    Return a brief but helpful description of the Criterion type,
    preferably based on the classes __doc__ string.

Definition at line 77 of file AbstractCriterion.py.

00077 
00078     def Description( self ):
00079         """
00080             Return a brief but helpful description of the Criterion type,
00081             preferably based on the classes __doc__ string.
00082         """
00083         lines = [ line.strip() for line in self.__doc__.splitlines() ]
00084         return ' '.join( [ line for line in lines if line ] )
00085 
00086 InitializeClass( AbstractCriterion )

Here is the caller graph for this function:

    Return a list of editable attributes, used by topics
    to build commands to send to the 'edit' command of each
    criterion, which may vary.

    Requires concrete subclasses to implement the attribute
    '_editableAttributes' which is a tuple of attributes
    that can be edited, for example:

    _editableAttributes = ( 'value', 'direction' )

Definition at line 43 of file AbstractCriterion.py.

00043 
00044     def editableAttributes( self ):
00045         """
00046             Return a list of editable attributes, used by topics
00047             to build commands to send to the 'edit' command of each
00048             criterion, which may vary.
00049 
00050             Requires concrete subclasses to implement the attribute
00051             '_editableAttributes' which is a tuple of attributes
00052             that can be edited, for example:
00053 
00054             _editableAttributes = ( 'value', 'direction' )
00055         """
00056         return self._editableAttributes

    Return the field that this criterion searches on.  The
    concrete subclasses can override this method, or have
    the 'field' attribute.

Definition at line 68 of file AbstractCriterion.py.

00068 
00069     def Field( self ):
00070         """
00071             Return the field that this criterion searches on.  The
00072             concrete subclasses can override this method, or have
00073             the 'field' attribute.
00074         """
00075         return self.field

Here is the caller graph for this function:

    Return the Type of Criterion this object is.  This
    method can be overriden in subclasses, or those
    concrete subclasses must define the 'meta_type'
    attribute.

Definition at line 58 of file AbstractCriterion.py.

00058 
00059     def Type( self ):
00060         """
00061             Return the Type of Criterion this object is.  This
00062             method can be overriden in subclasses, or those
00063             concrete subclasses must define the 'meta_type'
00064             attribute.
00065         """
00066         return self.meta_type


Member Data Documentation

tuple CMFTopic.AbstractCriterion.AbstractCriterion.security = ClassSecurityInfo() [static]

Definition at line 32 of file AbstractCriterion.py.


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