com.ibm.portal.resolver.portlet
Interface RenderEventRequest

All Superinterfaces:
Addressable, EventRequest, Identifiable, ParameterAccessor

public interface RenderEventRequest
extends EventRequest, Addressable

Represents the state of the render event and its context. The Addressable interface refers to the URI and the parameters targeted for the portlet window. The PortletPreferences refer to the preferences of the portlet window.

Since:
6.1.0
See Also:
RenderEventResponse

Field Summary
 
Fields inherited from interface com.ibm.portal.resolver.data.Addressable
EMPTY_PARAMETERS
 
Method Summary
 java.util.Map<java.lang.String,java.lang.String[]> getParameters()
           Returns an potentially unmodifiable version of the parameters used to address the object, never null, but potentially the empty map.
 java.net.URI getURI()
          Returns the unique identifier of the object.
 
Methods inherited from interface com.ibm.portal.resolver.portlet.EventRequest
getContext, getLocalName, getNamespace, getObjectID, getPortletDefinition, getPortletEntity, getPortletWindow, getPreferences, getPublicRenderParameterNames, getUserPrincipal
 
Methods inherited from interface com.ibm.portal.resolver.accessors.url.ParameterAccessor
getParameter, getParameter, getParameters, getParameters
 

Method Detail

getParameters

java.util.Map<java.lang.String,java.lang.String[]> getParameters()

Returns an potentially unmodifiable version of the parameters used to address the object, never null, but potentially the empty map.

The key is of type String, the values of type String[]

This map is different from the render parameters. Use RenderEventResponse.getParameters() to access the render parameters.

Specified by:
getParameters in interface Addressable
Specified by:
getParameters in interface EventRequest
Specified by:
getParameters in interface ParameterAccessor
Returns:
parameter map

getURI

java.net.URI getURI()
Returns the unique identifier of the object. The URI must contain valid scheme information and cannot be just a relative URL.

Specified by:
getURI in interface Addressable
Specified by:
getURI in interface EventRequest
Returns:
URI of the object, never null.