|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EventRequest
Represents the basic state of the render or resource event and its context.
RenderEventRequest
,
RenderEventResponse
Field Summary |
---|
Fields inherited from interface com.ibm.portal.resolver.data.Addressable |
---|
EMPTY_PARAMETERS |
Method Summary | |
---|---|
Context |
getContext()
Returns the COR context for the render event, this context can e.g. |
java.lang.String |
getLocalName(javax.xml.namespace.QName qName)
Returns the local name for a public render parameter name |
java.lang.String |
getNamespace()
The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the portal page. |
ObjectID |
getObjectID()
Returns the ObjectID of the portlet window that triggered the
current request. |
java.util.Map<java.lang.String,java.lang.String[]> |
getParameters()
Returns an unmodifiable version of the event parameters, never null , but potentially the empty map. |
PortletDefinition |
getPortletDefinition()
Returns the portlet definition |
PortletEntity |
getPortletEntity()
Returns the portlet entity |
PortletWindow |
getPortletWindow()
Returns the portlet window |
javax.portlet.PortletPreferences |
getPreferences()
Returns the read-only preferences of the addressed portlet window |
java.util.Set<java.lang.String> |
getPublicRenderParameterNames()
Returns an unmodifiable set of the names of the public render parameters of the targeted portlet |
java.net.URI |
getURI()
Returns the unique identifier of the event |
java.security.Principal |
getUserPrincipal()
Returns a Principal object containing the name of the current
authenticated user. |
Methods inherited from interface com.ibm.portal.resolver.accessors.url.ParameterAccessor |
---|
getParameter, getParameter, getParameters, getParameters |
Method Detail |
---|
Context getContext()
null
java.lang.String getLocalName(javax.xml.namespace.QName qName)
qName
- the qname
null
if the portlet does not
declare the parameterjava.lang.String getNamespace()
PortletResponse.getNamespace()
ObjectID getObjectID()
ObjectID
of the portlet window that triggered the
current request.
getObjectID
in interface Identifiable
java.util.Map<java.lang.String,java.lang.String[]> getParameters()
Returns an unmodifiable version of the event parameters, never
null
, but potentially the empty map.
The key is of type String
, the values of type
String[]
getParameters
in interface Addressable
getParameters
in interface ParameterAccessor
PortletDefinition getPortletDefinition()
PortletEntity getPortletEntity()
PortletWindow getPortletWindow()
javax.portlet.PortletPreferences getPreferences()
null
java.util.Set<java.lang.String> getPublicRenderParameterNames()
java.net.URI getURI()
getURI
in interface Addressable
null
java.security.Principal getUserPrincipal()
Principal
object containing the name of the current
authenticated user.
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |