ilog.views.util.servlet

Class IlvServletParameterHandler

java.lang.Object

ilog.views.util.servlet.IlvServletParameterHandler

Direct Known Subclasses:

IlvManagerServletParameterHandlerFactory.DynamicActionRequestParametersHandler

public abstract class IlvServletParameterHandler
extends Object

An abstract superclass that is designed to work as the handler for specific servlet requests. The subclass should call addParameter method to add customized parameters or use removeParameter to remove parameter for the specific request.

Since:

JViews 8.8

Constructor Summary

Constructors

Constructor and Description
IlvServletParameterHandler() The default constructor.

Method Summary

Modifier and Type	Method and Description
void	addParameter(String name) Adds the specific request parameter for requested name.
void	addParameter(String name, boolean required) Adds the specific request parameter for requested name.
void	addParameter(String name, boolean required, String value) Adds the specific request parameter for requested name.
void	addParameter(String name, boolean required, String value, boolean compared) Adds the specific request parameter for requested name.
void	addParameter(String name, boolean required, String value, boolean compared, IlvRequestParameter.Comparator comparator) Adds the specific request parameter for requested name.
Set<String>	getAllParameterNames() Returns the set of all parameter name.
Set<IlvRequestParameter>	getRequetsParameter(String name) Returns the set of specific request parameters IlvRequestParameter from requested parameter name.
Set<String>	getRequiredParameterNames() Returns the set of all required parameter name.
boolean	isEmpty() Returns the parameter set status for the specific request.
void	removeParameter(String name) Removes the specific request parameter for requested name.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvServletParameterHandler

public IlvServletParameterHandler()

The default constructor. This constructor will add the parameters: "jviewsPageId", "locale", "request", and "namespace".

Method Detail

addParameter

public void addParameter(String name)

Adds the specific request parameter for requested name.

Parameters:

name - the parameter name

addParameter

public void addParameter(String name,
                         boolean required)

Adds the specific request parameter for requested name.

Parameters:

name - the parameter name.

required - Whether the parameter is required.

addParameter

public void addParameter(String name,
                         boolean required,
                         String value)

Adds the specific request parameter for requested name.

Parameters:

name - the parameter name.

required - Whether the parameter is required.

value - The default parameter value.

addParameter

public void addParameter(String name,
                         boolean required,
                         String value,
                         boolean compared)

Adds the specific request parameter for requested name.

Parameters:

name - the parameter name.

required - Whether the parameter is required.

value - The default parameter value.

compared - Whether the parameter value should be compared with default value.

addParameter

public void addParameter(String name,
                         boolean required,
                         String value,
                         boolean compared,
                         IlvRequestParameter.Comparator comparator)

Adds the specific request parameter for requested name.

Parameters:

name - the parameter name.

required - Whether the parameter is required.

value - The default parameter value.

compared - Whether the parameter value should be compared with default value.

comparator - which kind of operation needed for parameter value comparison if compared is true.

removeParameter

public void removeParameter(String name)

Removes the specific request parameter for requested name.

Parameters:

name - the parameter name.

getRequetsParameter

public Set<IlvRequestParameter> getRequetsParameter(String name)

Returns the set of specific request parameters IlvRequestParameter from requested parameter name.

Parameters:

name - the parameter name.

Returns:

The specific request parameter from requested parameter name.

isEmpty

public boolean isEmpty()

Returns the parameter set status for the specific request.

Returns:

true if there is no parameter related for the specific request, or false othewise.

getAllParameterNames

public Set<String> getAllParameterNames()

Returns the set of all parameter name.

Returns:

The set of all parameter name.

getRequiredParameterNames

public Set<String> getRequiredParameterNames()

Returns the set of all required parameter name.

Returns:

The set of all required parameter name.