Package org.gatein.pc.controller.request

Class PortletEventRequest

java.lang.Object

org.gatein.pc.controller.request.ControllerRequest

org.gatein.pc.controller.request.ContainerRequest

org.gatein.pc.controller.request.PortletRequest

org.gatein.pc.controller.request.PortletEventRequest

public class PortletEventRequest
extends PortletRequest

An event request. The purpose of this type of request is to allow the portal to fire events to a portlet.

Field Summary

Fields inherited from class org.gatein.pc.controller.request.PortletRequest

pageNavigationalState, windowNavigationalState

Fields inherited from class org.gatein.pc.controller.request.ContainerRequest

windowId

Constructor Summary

Constructors

Constructor	Description
PortletEventRequest(String windowId, WindowNavigationalState windowNavigationalState, PageNavigationalState pageNavigationalState, QName name, Serializable payload)

Method Summary

Modifier and Type	Method	Description
QName	getName()
Serializable	getPayload()
org.gatein.pc.api.invocation.response.PortletInvocationResponse	invoke(ControllerContext controllerContext)

Methods inherited from class org.gatein.pc.controller.request.PortletRequest

getPageNavigationalState, getWindowNavigationalState

Methods inherited from class org.gatein.pc.controller.request.ContainerRequest

getWindowId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PortletEventRequest

public PortletEventRequest(String windowId,
 WindowNavigationalState windowNavigationalState,
 PageNavigationalState pageNavigationalState,
 QName name,
 Serializable payload)

Method Details

getName

public QName getName()

getPayload

public Serializable getPayload()

invoke

public org.gatein.pc.api.invocation.response.PortletInvocationResponse invoke(ControllerContext controllerContext)
                                                                       throws org.gatein.pc.api.PortletInvokerException

Specified by:

invoke in class ControllerRequest

Throws:

org.gatein.pc.api.PortletInvokerException