com.sun.rave.web.ui.component.util.event
Interface OutputType

All Known Implementing Classes:
RequestAttributeOutputType, SessionAttributeOutputType

public interface OutputType

This interface provides an abstraction for different locations for storing output from a handler. Implementations may store values in Session, request attributes, databases, etc.


Method Summary
 java.lang.Object getValue(HandlerContext context, IODescriptor outDesc, java.lang.String key)
           This method is responsible for retrieving the value of the Output from the destination that was specified by handler.
 void setValue(HandlerContext context, IODescriptor outDesc, java.lang.String key, java.lang.Object value)
           This method is responsible for setting the value of the Output to the destination that was specified by handler.
 

Method Detail

getValue

java.lang.Object getValue(HandlerContext context,
                          IODescriptor outDesc,
                          java.lang.String key)

This method is responsible for retrieving the value of the Output from the destination that was specified by handler. 'key' may be null. In cases where it is not needed, it can be ignored. If it is needed, the implementation may either provide a default or throw an exception.

Parameters:
context - The HandlerContext
outDesc - The IODescriptor for this Output value in which to obtain the value
key - The optional 'key' to use when retrieving the value from the OutputType
Returns:
The requested value.

setValue

void setValue(HandlerContext context,
              IODescriptor outDesc,
              java.lang.String key,
              java.lang.Object value)

This method is responsible for setting the value of the Output to the destination that was specified by handler. 'key' may be null. In cases where it is not needed, it can be ignored. If it is needed, the implementation may either provide a default or throw an exception.

Parameters:
context - The HandlerContext
outDesc - The IODescriptor for this Output value in which to obtain the value
key - The optional 'key' to use when setting the value from the OutputType
value - The value to set