org.apache.cocoon.portal.wsrp.consumer
Interface Request

All Known Implementing Classes:
RequestImpl

public interface Request

Defines a request from the end-user to the swing consumer as result of an interaction (e.g. click on hyperlink) of the end-user with the representation of a remote portlet.
Due to the two phase protocol of WSRP this request carries information which need to be passed back to the producer in order to process the interaction at the producer-side.

Version:
$Id: Request.java 322475 2005-10-16 14:26:44Z cziegeler $

Method Summary
 void addFormParameter(String name, String value)
          Add any parameters to the request.
 oasis.names.tc.wsrp.v1.types.NamedString[] getFormParameters()
          Get all form parameters from the request.
 String getInteractionState()
          Get the interaction state of the portlet.
 void setInteractionState(String state)
          Set the interaction state of a portlet which should be passed to the producer.
 

Method Detail

setInteractionState

public void setInteractionState(String state)
Set the interaction state of a portlet which should be passed to the producer.

Parameters:
state - the interaction state of a portlet

getInteractionState

public String getInteractionState()
Get the interaction state of the portlet.

Returns:
interaction state of a portlet carried in a request

addFormParameter

public void addFormParameter(String name,
                             String value)
Add any parameters to the request. These parameters should be carried in the form parameters field of WSRP.

Parameters:
name - The key which identifies the parameter
value - The value of the parameter

getFormParameters

public oasis.names.tc.wsrp.v1.types.NamedString[] getFormParameters()
Get all form parameters from the request. The returned NamedString array contains all parameter key/value pairs and can directly be passed to the form parameter field in WSRP.

Returns:
Array with all set parameters


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.