Overview | Package | Class | Tree | Deprecated | Index | Help
| Copyright © 2008 BEA Systems, Inc. All Rights Reserved
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.wsrp.model.markup
Interface IBlockingInteractionRequestContext

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

    public interface IBlockingInteractionRequestContext

extends IBlockingInteractionBaseRequestContext

A request context that represents input data for the "performBlockingInteraction" 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` | `getInteractionRequestState()` Returns a custom data object that is being sent to the Producer as part of the "performBlockingInteraction" request.
`PortletStateChange` | `getPortletStateChange()` Returns portlet state change flag.
`void` | `setInteractionRequestState(InteractionRequestState interactionRequestState)` Sets the supplied `interactionRequestState` object as a custom data that is being sent to the Producer in the "performBlockingInteraction" request.
`void` | `setInteractionRequestState(XmlPayload xmlPayload)` Sets the supplied `xmlPayload` object as a custom data that will be sent to the Producer in the "performBlockingInteraction" request.

Methods inherited from interface com.bea.wsrp.model.markup.IBlockingInteractionBaseRequestContext
`addFormParameter, forceGetMarkupCall, getFormParameters, getInteractionState, getUploadedData, setFormParameter, setInteractionState, setUploadedData, shouldForceGetMarkupCall`

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

### getInteractionRequestState

    Object getInteractionRequestState()

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

  Returns
    a custom data object being sent to a producer.

### setInteractionRequestState

    void setInteractionRequestState(XmlPayload xmlPayload)

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

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

### setInteractionRequestState

    void setInteractionRequestState(InteractionRequestState interactionRequestState)

  Sets the supplied `interactionRequestState` object as a custom data that is being sent to the Producer in the "performBlockingInteraction" request.

  Parameters
    `interactionRequestState` - a new custom data object.
  See Also
    `SimpleStateHolder`

### getPortletStateChange

    PortletStateChange getPortletStateChange()

  Returns portlet state change flag.

  Returns
    state change flag

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008 BEA Systems, Inc. All Rights Reserved