Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

PREV class NEXT class

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.wps.portlet.event
Interface EventPhaseListener

public interface EventPhaseListener

Portlets can implement the EventPhaseListener interface to execute code before any or after all events have been received. This a and all other event listener interfaces are only available for portlets using the IBM Portlet API, which extend the Portlet class

To receive events, any of the following listener interfaces has to be implemented: MessageListener, ActionListener, PortletApplicationSettingsAttributesListener, PortletSettingsAttributesListener, WindowListener, PortletPageListener, PortletSessionListener, PortletTitleListener.

Since:

5.0

Note:

This interface is designed to be implemented by clients.

Method Summary
void	beginEventPhase(PortletRequest portletRequest) Invoked on all portlets implementing this interface before the event phase has begun, i.e., before any of the methods of the listener interfaces, e.g., ActionListener.actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent), have been executed.
void	endEventPhase(PortletRequest portletRequest) Invoked on all portlets implementing this interface after the event phase has completed, i.e., after all methods of the listener interfaces, e.g., ActionListener.actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent), have been executed.

Method Detail

beginEventPhase

public void beginEventPhase(PortletRequest portletRequest)

Invoked on all portlets implementing this interface before the event phase has begun, i.e., before any of the methods of the listener interfaces, e.g., ActionListener.actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent), have been executed.

Parameters:

portletRequest - the PortletRequest object that is sent to the portlet

endEventPhase

public void endEventPhase(PortletRequest portletRequest)

Invoked on all portlets implementing this interface after the event phase has completed, i.e., after all methods of the listener interfaces, e.g., ActionListener.actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent), have been executed.

Parameters:

portletRequest - the PortletRequest object that is sent to the portlet