Back to index

plone3  3.1.7
Public Member Functions
plone.contentrules.engine.interfaces.IRuleExecutor Class Reference
Inheritance diagram for plone.contentrules.engine.interfaces.IRuleExecutor:
Inheritance graph
[legend]
Collaboration diagram for plone.contentrules.engine.interfaces.IRuleExecutor:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def __call__

Detailed Description

An object that is capable of executing rules.

Typically, a content object will be adapted to this interface

Definition at line 51 of file interfaces.py.


Member Function Documentation

def plone.contentrules.engine.interfaces.IRuleExecutor.__call__ (   event,
  bubbled = False,
  rule_filter = None 
)
Execute all rules applicable in the current context

event is the triggering event. bubbled should be True if the rules
are being executed as part of a bubbling up of events (i.e. this
is a parent of the context where the event was triggered). filter,
if given, is a callable that will be passed each rule in turn and
can vote on whether it should be executed by returning True or
False. It should take the arguments (context, rule, event).

Definition at line 57 of file interfaces.py.

00057 
00058     def __call__(event, bubbled=False, rule_filter=None):
00059         """Execute all rules applicable in the current context
00060         
00061         event is the triggering event. bubbled should be True if the rules
00062         are being executed as part of a bubbling up of events (i.e. this
00063         is a parent of the context where the event was triggered). filter,
00064         if given, is a callable that will be passed each rule in turn and
00065         can vote on whether it should be executed by returning True or
00066         False. It should take the arguments (context, rule, event).
        """

Here is the caller graph for this function:


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