com.bea.wsrp.model.markup
Interface IGetMarkupRequestContext

All Superinterfaces

IBaseRequestContext, IGetMarkupBaseRequestContext, IMutableRegistrationContext, INillable, com.bea.wsrp.bind.IPortletContextHolder, IRegistrationContext, IRuntimeContext, IUserContext, Serializable

All Known Subinterfaces:

IGetRenderDependenciesRequestContext, IGetResourceRequestContext

public interface IGetMarkupRequestContext
extends IGetMarkupBaseRequestContext

A request context that represents input data for the "getMarkup" operation. This also provides methods for custom data transfer which is applicable only in the WLP Consumer/Producer combination.

This interface is intended to be implemented only by BEA Weblogic Portal. BEA 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 BEA Weblogic Portal.

Method Summary

Object	getMarkupRequestState() Returns a custom data object that is being sent to the Producer as part of the "getMarkup" request.
void	setMarkupRequestState(MarkupRequestState markupRequestState) Sets the supplied markupRequestState object as a custom data that is being sent to the Producer in the "getMarkup" request.
void	setMarkupRequestState(XmlPayload xmlPayload) Sets the supplied xmlPayload object as a custom data that will be sent to the Producer in the "getMarkup" request.

Methods inherited from interface com.bea.wsrp.model.markup.IGetMarkupBaseRequestContext

addLocale, addMarkupCharacterSet, addMimeType, getLocales, getMarkupCharacterSets, getMimeTypes, getMode, getNavigationalState, getPublicNavigationalState, getRequestVerb, getUserAgent, getWindowState, isSecureClientCommunicationOn, isValidateTagOn, setMarkupCharacterSet, setMode, setNavigationalState, setPublicNavigationalState, setRequestVerb, setUserAgent, setValidateTagOn, setWindowState

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

Methods inherited from interface com.bea.wsrp.model.markup.IRuntimeContext

getDoctypeUri, getNamespacePrefix, getPortletInstanceKey, getSessionID, getSkeleton, getSkeletonChromosome, getSkeletonPath, getSkin, getSkinChromosome, getSkinPath, getTemplates, getThemeName, getThemeSkeletonChromosome, getThemeSkinChromosome, getUserAuthentication, isReturnContentToCaller, isUsingAltSkeleton, isUsingAltSkin, setDoctypeUri, setNamespacePrefix, setPortletInstanceKey, setReturnContentToCaller, setSessionID, setSkeleton, setSkeletonChromosome, setSkeletonPath, setSkin, setSkinChromosome, setSkinPath, setTemplates, setThemeName, setThemeSkeletonChromosome, setThemeSkinChromosome, setUserAuthentication, setUsingAltSkeleton, setUsingAltSkin

Method Detail

getMarkupRequestState

Object getMarkupRequestState()

Returns a custom data object that is being sent to the Producer as part of the "getMarkup" request. The returned object type can be XmlPayload or MarkupRequestState.

Returns

a custom data object being sent to a producer.

setMarkupRequestState

void setMarkupRequestState(XmlPayload xmlPayload)

Sets the supplied xmlPayload object as a custom data that will be sent to the Producer in the "getMarkup" request.

Parameters

xmlPayload - a new custom data object.

See Also

XmlPayload

setMarkupRequestState

void setMarkupRequestState(MarkupRequestState markupRequestState)

Sets the supplied markupRequestState object as a custom data that is being sent to the Producer in the "getMarkup" request.

Parameters

markupRequestState - a new custom data object.

See Also

SimpleStateHolder