|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents the data available in a request made to a pagelet. Pagelets are remote user interface components that can represent widgets or entire applications.
Method Summary | |
IEnvironment |
getEnvironment()
Gets an IEnvironment instance that provides information about the environment in
which this proxied resource is being requested. |
java.net.URL |
getHostPageURI()
Returns the URI for the page in which the pagelet is currently displayed. |
java.lang.String |
getIdentifier()
Gets the identifier for this resource. |
java.net.URL |
getImageServerURI()
Returns the URI for the image server for the the application container or runtime environment in which the pagelet is currently displayed. |
java.lang.String |
getInstanceIdentifier()
Gets the instance identifier for the requested resource. |
IPayload |
getPayload()
Gets the optional payload information that may be available for this request. |
java.lang.String |
getSetting(java.lang.String name)
Gets a setting value with the given name . |
java.net.URL |
getStylesheetURI()
Returns the URI for the stylesheet for the page in which the pagelet is currently displayed. |
IProxyUser |
getUser()
Gets the IProxyUser representing the user making a pagelet request. |
Methods inherited from interface com.plumtree.remote.portlet.IGenericRequest |
getLoginToken, getRemoteAPIEndpoint |
Method Detail |
public IEnvironment getEnvironment()
IEnvironment
instance that provides information about the environment in
which this proxied resource is being requested. Note: The environment type describes
the nature of the request and not the nature of the application container or runtime
environment.
public java.lang.String getIdentifier()
NotGatewayedException
- if the request is not gatewayedpublic java.lang.String getInstanceIdentifier()
NotGatewayedException
- if the request is not gatewayedpublic IPayload getPayload()
IPayload
public java.lang.String getSetting(java.lang.String name)
name
.
name
- the name of the setting to retrieve
null
if the setting was not sent
NotGatewayedException
- if the request is not gatewayedpublic IProxyUser getUser()
IProxyUser
representing the user making a pagelet request.
public java.net.URL getHostPageURI()
NotGatewayedException
- if the request is not gatewayedpublic java.net.URL getImageServerURI()
NotGatewayedException
- if the request is not gatewayedpublic java.net.URL getStylesheetURI()
NotGatewayedException
- if the request is not gatewayed
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.