com.bea.wsrp.model.markup
Interface IInteractionResponseContext

All Superinterfaces
IEventManipulator, com.bea.wsrp.bind.IPortletContextHolder
All Known Subinterfaces:
IBlockingInteractionBaseResponseContext, IBlockingInteractionResponseContext, IHandleEventsResponseContext

public interface IInteractionResponseContext
extends com.bea.wsrp.bind.IPortletContextHolder, IEventManipulator

A base interaction response context that represents partial output data of the "performBlockingInteraction" and "handleEvents" operations. This also provides methods for custom data transfer which is applicable only in the WLP Consumer/Producer combination, and for handleEvents only over WSRP version 2.

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
 Object getInteractionResponseState()
          Returns a custom data object that is in the response of the "performBlockingInteraction" operation, or if using WSRP v2 in the response of the "handleEvents" operation.
 String getNavigationalState()
          Returns the opaque navigational state of the current portlet.
 String getNewMode()
          Returns a new mode for the current portlet.
 String getNewWindowState()
          Returns a new window state for the current portlet.
 PortletParameters getPublicNavigationalState()
          Returns the public navigational state of the current portlet.
 void setInteractionResponseState(InteractionResponseState interactionResponseState)
          Sets the supplied interactionResponseState object as a custom data that is in the response of the "performBlockingInteraction" operation, or if using WSRP v2 in the response of the "handleEvents" operation.
 void setInteractionResponseState(XmlPayload xmlPayload)
          Sets the supplied xmlPayload object as a custom data that is in the response of the "performBlockingInteraction" operation, or if using WSRP v2 in the response of the "handleEvents" operation.
 void setNavigationalState(String navState)
          Sets the supplied navState as the opaque navigational state for the current portlet.
 void setNewMode(String newMode)
          Sets the supplied newMode as a new window mode for the current portlet.
 void setNewWindowState(String newWindowState)
          Sets the supplied newWindowState as a new window state for the current portlet.
 void setPublicNavigationalState(PortletParameters publicNavState)
          Sets the public navigational state for the current portlet.
 
Methods inherited from interface com.bea.wsrp.bind.IPortletContextHolder
getPortletContext
 
Methods inherited from interface com.bea.wsrp.model.markup.IEventManipulator
createEventContext, getEventContext, getEventContexts, getEventCount, getEvents, setEventContexts, setEvents
 

Method Detail

getNavigationalState

String getNavigationalState()
Returns the opaque navigational state of the current portlet.

Returns
a string that represents a navigational state of the current portlet.

setNavigationalState

void setNavigationalState(String navState)
Sets the supplied navState as the opaque navigational state for the current portlet.

Parameters
navState - a new navigational state.

getPublicNavigationalState

PortletParameters getPublicNavigationalState()
Returns the public navigational state of the current portlet.


setPublicNavigationalState

void setPublicNavigationalState(PortletParameters publicNavState)
Sets the public navigational state for the current portlet.

Parameters
publicNavState - the new public navigational state.

getNewWindowState

String getNewWindowState()
Returns a new window state for the current portlet. This is not for rendering a remote portlet. The Consumer may map this new window state string to a state string that can be rendered.

Returns
a new window state.

setNewWindowState

void setNewWindowState(String newWindowState)
Sets the supplied newWindowState as a new window state for the current portlet.

Parameters
newWindowState - a new window state.

getNewMode

String getNewMode()
Returns a new mode for the current portlet. This is not for rendering a remote portlet. The Consumer may map this new mode string to a mode string that can be rendered.

Returns
a new mode.

setNewMode

void setNewMode(String newMode)
Sets the supplied newMode as a new window mode for the current portlet.

Parameters
newMode - a new mode.

getInteractionResponseState

Object getInteractionResponseState()
Returns a custom data object that is in the response of the "performBlockingInteraction" operation, or if using WSRP v2 in the response of the "handleEvents" operation. The returned object type can be XmlPayload or MarkupResponseState.

Returns
a custom data object received from a producer.

setInteractionResponseState

void setInteractionResponseState(XmlPayload xmlPayload)
Sets the supplied xmlPayload object as a custom data that is in the response of the "performBlockingInteraction" operation, or if using WSRP v2 in the response of the "handleEvents" operation.

Parameters
xmlPayload - a new custom data object.
See Also
XmlPayload

setInteractionResponseState

void setInteractionResponseState(InteractionResponseState interactionResponseState)
Sets the supplied interactionResponseState object as a custom data that is in the response of the "performBlockingInteraction" operation, or if using WSRP v2 in the response of the "handleEvents" operation.

Parameters
interactionResponseState - a new custom data object.
See Also
SimpleStateHolder


Copyright © 2011, Oracle. All rights reserved.