Skip navigation links

oracle.stellent.wcm.client.filter
Class FilterContext

java.lang.Object
oracle.stellent.wcm.client.filter.FilterContext

public class FilterContext

extends java.lang.Object

Context for a client filter call

Constructor Summary

FilterContext()

FilterContext(RequestContext requestContext)

FilterContext(RequestContext requestContext, java.util.Map<java.lang.String,java.lang.Object> parameters)

Method Summary

void	addParameter(java.lang.String name, java.lang.Object value) Add a parameter to the filter; usually invoked by the caller of the filter
java.lang.Object	getParameter(java.lang.String name) Retrieve a parameter by name
java.util.Map<java.lang.String,java.lang.Object>	getParameters()
RequestContext	getRequestContext()
java.lang.Object	getReturnValue()
void	setReturnValue(java.lang.Object returnValue) Set the return value of the filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterContext

public FilterContext()

FilterContext

public FilterContext(RequestContext requestContext)

FilterContext

public FilterContext(RequestContext requestContext,
                     java.util.Map<java.lang.String,java.lang.Object> parameters)

Method Detail

getRequestContext

public RequestContext getRequestContext()

Returns:

the request context

getParameters

public java.util.Map<java.lang.String,java.lang.Object> getParameters()

Returns:

the filter parameters

addParameter

public void addParameter(java.lang.String name,
                         java.lang.Object value)

Add a parameter to the filter; usually invoked by the caller of the filter

Parameters:

name - the parameter name

value - the parameter value

getParameter

public java.lang.Object getParameter(java.lang.String name)

Retrieve a parameter by name

Parameters:

name - the parameter name

Returns:

the parameter value

getReturnValue

public java.lang.Object getReturnValue()

Returns:

the return value of the filter

setReturnValue

public void setReturnValue(java.lang.Object returnValue)

Set the return value of the filter.

Parameters:

returnValue - the return value

Skip navigation links