|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IGetMarkupBaseRequestContext
A base request context that represents partial input data for the "getMarkup" operation. It includes accessors and mutators for most of the elements of markup described in the WSRP specification, except WLP extensions.
Method Summary | |
---|---|
void |
addLocale(Locale locale)
Adds the supplied locale to the end of the list. |
void |
addMarkupCharacterSet(String markupCharacterSet)
Adds the supplied markupCharacterSet to the set of character sets that
WLP Consumer is sending to a producer. |
void |
addMimeType(String mimeType)
Addes the supplied mimeType towards the end of the current list of Mime types. |
List<Locale> |
getLocales()
A list of locales that the WLP Consumer computed for the current portlet to generate markup. |
Set<String> |
getMarkupCharacterSets()
The character sets that WLP Consumer wants the Producer use to encode the current portlet's markup. |
List<String> |
getMimeTypes()
A list of Mime types (text/html, text/xml, application/xhtml+xml, etc) that the WLP Consumer prefers the Producer to generate a portlet's markup. |
String |
getMode()
The mode of a portlet for which the Producer generates markup. |
String |
getNavigationalState()
Returns the opaque navigational state of the current portlet. |
PortletParameters |
getPublicNavigationalState()
Returns the public navigational state of the current portlet. |
String |
getRequestVerb()
Returns the request method. |
String |
getUserAgent()
A string identifying user-agent of an end-user. |
String |
getWindowState()
The state of the current portlet's virtual window. |
boolean |
isSecureClientCommunicationOn()
Indicates whether client is using a secure communication channel between client and the Consumer. |
boolean |
isValidateTagOn()
Returns true if the Producer sent a validateTag in previous requests and the WLP Consumer has cached markup for the current portlet. |
void |
setMarkupCharacterSet(Set<String> markupCharacterSet)
Uses the supplied set of character sets as the markup character sets for the current portlet. |
void |
setMode(String mode)
The supplied mode is set as the portlet's mode. |
void |
setNavigationalState(String navState)
The supplied navState is set as the opaque navigational state of the
current portlet. |
void |
setPublicNavigationalState(PortletParameters publicState)
Sets the public navigational state of the current portlet. |
void |
setRequestVerb(String requestVerb)
Sets the request method. |
void |
setUserAgent(String newUserAgent)
Sets the supplied newUserAgent as an user-agent
of an end-user. |
void |
setValidateTagOn(boolean value)
Sets the supplied value for the validateTag on field. |
void |
setWindowState(String windowState)
The supplied windowState is set as the portlet's state. |
Methods inherited from interface com.bea.wsrp.model.markup.IBaseRequestContext |
---|
addMimeHeader, getHttpServletRequest, getHttpServletResponse, getMimeHeaders, getMimeHeaders, getProducerInfo, getServletContext, removeMimeHeader, setMimeHeader |
Methods inherited from interface com.bea.wsrp.model.IMutableRegistrationContext |
---|
setRegistrationHandle, setRegistrationState |
Methods inherited from interface com.bea.wsrp.model.IRegistrationContext |
---|
getRegistrationHandle, getRegistrationState |
Methods inherited from interface com.bea.wsrp.model.INillable |
---|
isNil |
Methods inherited from interface com.bea.wsrp.model.markup.IUserContext |
---|
getUserContextKey, getUserProfile, setUserContextKey |
Methods inherited from interface com.bea.wsrp.model.INillable |
---|
isNil |
Methods inherited from interface com.bea.wsrp.bind.IPortletContextHolder |
---|
getPortletContext |
Method Detail |
---|
boolean isSecureClientCommunicationOn()
List<Locale> getLocales()
Locale
s.void addLocale(Locale locale)
locale
to the end of the list.
Note: this method doesn't check if the supplied locale
is allowed
or not.
locale
- A Locale
to add.List<String> getMimeTypes()
void addMimeType(String mimeType)
mimeType
towards the end of the current list of Mime types.
mimeType
- A Mime type to add.String getMode()
void setMode(String mode)
mode
is set as the portlet's mode. The value can be any supported modes specified
in the current portlet's metadata or "wsrp:view".
mode
- A supported portlet's mode.String getWindowState()
void setWindowState(String windowState)
windowState
is set as the portlet's state. The value can be any supported states
specified in the current portlet's metadata or "wsrp:normal".
windowState
- A supported portlet's window state.String getNavigationalState()
void setNavigationalState(String navState)
navState
is set as the opaque navigational state of the
current portlet. To set the public navigational state, use the
setPublicNavigationalState() method.
navState
- The opaque navigational state of the current portlet.PortletParameters getPublicNavigationalState()
void setPublicNavigationalState(PortletParameters publicState)
publicState
- the public navigational state of the current portlet.Set<String> getMarkupCharacterSets()
void addMarkupCharacterSet(String markupCharacterSet)
markupCharacterSet
to the set of character sets that
WLP Consumer is sending to a producer.
markupCharacterSet
- A character set.void setMarkupCharacterSet(Set<String> markupCharacterSet)
markupCharacterSet
- A set of markup character sets.boolean isValidateTagOn()
void setValidateTagOn(boolean value)
value
for the validateTag on field.
value
- A boolean value.String getUserAgent()
void setUserAgent(String newUserAgent)
newUserAgent
as an user-agent
of an end-user.
newUserAgent
- A new user-agent identification.String getRequestVerb()
void setRequestVerb(String requestVerb)
requestVerb
- request method
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |