Back to index

plone3  3.1.7
_events.py
Go to the documentation of this file.
00001 ##############################################################################
00002 #
00003 # Copyright (c) 2006 Zope Corporation and Contributors. All Rights Reserved.
00004 #
00005 # This software is subject to the provisions of the Zope Public License,
00006 # Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
00007 # THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
00008 # WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00009 # WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
00010 # FOR A PARTICULAR PURPOSE.
00011 #
00012 ##############################################################################
00013 """ CMFCore event interfaces.
00014 
00015 $Id: _events.py 71686 2007-01-02 14:51:01Z tseaver $
00016 """
00017 from zope.interface import Attribute
00018 from zope.component.interfaces import IObjectEvent
00019 
00020 
00021 class IWorkflowActionEvent(IObjectEvent):
00022     
00023     """Base interface for events around workflow action invocation
00024     """
00025     
00026     workflow = Attribute("The workflow definition object")
00027     action = Attribute("The name of the action being invoked")
00028     
00029 class IActionWillBeInvokedEvent(IWorkflowActionEvent):
00030     
00031     """Event fired immediately before a workflow action is invoked
00032     """
00033     
00034 class IActionRaisedExceptionEvent(IWorkflowActionEvent):
00035     
00036     """Event fired when a workflow action raised an exception
00037     """
00038     
00039     exc = Attribute("The exception info for the exception raised")
00040     
00041 class IActionSucceededEvent(IWorkflowActionEvent):
00042     
00043     """Event fired when a workflow action succeeded
00044     """
00045     
00046     result = Attribute("The result of the workflow action")