com.ibm.portal.resolver.portlet
Interface RenderEventListener
- All Superinterfaces:
- java.util.EventListener
-
public interface RenderEventListener
- extends java.util.EventListener
Convenience implementation of a ResolutionService for the special
case that a portlet window registers such a service and the service only
needs to modify the private render parameters of that portlet window (which
should be the typical case). Use the following metadata in the
portlet.xml to register for this event.
<init-param>
<name>com.ibm.portal.resolver.ResolutionService</name>
<value>com.ibm.portal.resolver.portlet.RenderEventListener</value>
</init-param>
<init-param>
<name>com.ibm.portal.resolver.portlet.RenderEventListener</name>
<value>%SERVICE_ID_OF_THE_IMPL%</value>
</init-param>
- Since:
- 8.5
- Note:
This interface is designed to be implemented by clients. |
onRenderEvent
boolean onRenderEvent(RenderEventRequest req,
RenderEventResponse resp)
throws ResolutionException,
StateException
- Performs a render event on the portlet. This event has no side effects
and only updates the private render parameters of the target portlet
window.
- Parameters:
- req - request that encapsulates the event information, not
null
- resp - response that encapsulates the state of the portlet window,
not null
- Returns:
- true if the implementation handled the event, else
false
- Throws:
- ResolutionException - if an error occured during the resolution
- StateException - if an error occurred during state management