Skip navigation links

com.bea.wsrp.model.markup
Interface IMimeRequestContext

public interface IMimeRequestContext

A request context that represents the MimeRequest Type (5.1.13) in the WSRP 2.0 specification. New in WSRP 2.0

This interface is intended to be implemented only by Oracle Weblogic Portal. Oracle Systems reserves the right to add abstract methods to this interface without notice. Implementations of this interface by other parties must not be expected to compile without change in future versions of Oracle Weblogic Portal.

Method Summary

com.bea.wsrp.model.markup.IClientData	addClientData() Add an IClientData structure to the request.
void	addLocale(Locale locale) Add the given locale.
void	addMarkupCharacterSet(String markupCharacterSet) Add given character set.
void	addMimeType(String mimeType) Add the given mimeType to the list.
com.bea.wsrp.model.markup.INavigationalContext	addNavigationalContext() Add empty Navigational Context to the request.
com.bea.wsrp.model.markup.IClientData	getClientData() Return the structure that provides client information.
List<Locale>	getLocales() Returns list of locales on the consumer's request.
Set<String>	getMarkupCharacterSets() Returns an array of character sets the consumer is willing to have the Portlet use.
List<String>	getMimeTypes() Returns list of mime types on the consumer's request.
String	getMode() The mode for which the Portlet should render its output.
com.bea.wsrp.model.markup.INavigationalContext	getNavigationalContext() Returns the Navigational context for the Portlet
String	getWindowState() State of the Portlet's virtual window relative to the other Portlet's on the aggregated page.
boolean	isValidateTagOn() Returns true if validate tag is on.
void	setMarkupCharacterSet(Set<String> markupCharacterSet) Set the characterSet to the given set.
void	setMode(String mode) Set the mode with the given mode.
void	setValidateTagOn(boolean validateTagOn) Set the validate tag.
void	setWindowState(String windowState) Set the window state to the given value.

Method Detail

getLocales

List<Locale> getLocales()

Returns list of locales on the consumer's request. The order represents the consumer's preference order.

Returns

list of locales on the consumer's request.

addLocale

void addLocale(Locale locale)

Add the given locale.

Parameters

locale -

getMimeTypes

List<String> getMimeTypes()

Returns list of mime types on the consumer's request. The order represents the consumer's preference order.

Returns

list of mime types on the consumer's request.

addMimeType

void addMimeType(String mimeType)

Add the given mimeType to the list.

Parameters

mimeType -

getMode

String getMode()

The mode for which the Portlet should render its output. All portlets are required to support the "wsrp:view" mode.

Returns

String representing mode

setMode

void setMode(String mode)

Set the mode with the given mode.

Parameters

mode -

getWindowState

String getWindowState()

State of the Portlet's virtual window relative to the other Portlet's on the aggregated page. All Portlet's must support "wsrp:normal".

Returns

String representing window state.

setWindowState

void setWindowState(String windowState)

Set the window state to the given value.

Parameters

windowState -

getClientData

com.bea.wsrp.model.markup.IClientData getClientData()

Return the structure that provides client information.

Returns

IClientData structure

addClientData

com.bea.wsrp.model.markup.IClientData addClientData()

Add an IClientData structure to the request.

Returns

empty IClientData structure

getNavigationalContext

com.bea.wsrp.model.markup.INavigationalContext getNavigationalContext()

Returns the Navigational context for the Portlet

Returns

INavigationalContext

addNavigationalContext

com.bea.wsrp.model.markup.INavigationalContext addNavigationalContext()

Add empty Navigational Context to the request.

Returns

empty INavigtaionContext structure created.

getMarkupCharacterSets

Set<String> getMarkupCharacterSets()

Returns an array of character sets the consumer is willing to have the Portlet use.

Returns

Set of CharacterSets

addMarkupCharacterSet

void addMarkupCharacterSet(String markupCharacterSet)

Add given character set.

Parameters

markupCharacterSet -

setMarkupCharacterSet

void setMarkupCharacterSet(Set<String> markupCharacterSet)

Set the characterSet to the given set.

Parameters

markupCharacterSet -

isValidateTagOn

boolean isValidateTagOn()

Returns true if validate tag is on.

Returns

boolean

setValidateTagOn

void setValidateTagOn(boolean validateTagOn)

Set the validate tag.

Parameters

validateTagOn -

Skip navigation links