ilog.views.util.servlet

Class IlvRequestParameter

java.lang.Object

ilog.views.util.servlet.IlvRequestParameter

public class IlvRequestParameter
extends Object

The class defines one specific request parameter.

Since:

JViews 8.8

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IlvRequestParameter.Comparator User can specify how to compare the parameter value by setting specific operation if user set compared to true.

Constructor Summary

Constructors

Constructor and Description
IlvRequestParameter(String name) The constructor with parameter name.
IlvRequestParameter(String name, boolean required) The constructor that the default parameter value is "" and the parameter value do not need compare with default value.
IlvRequestParameter(String name, boolean required, String value) The constructor that the parameter value do not need compare with default value.
IlvRequestParameter(String name, boolean required, String value, boolean compared) The constructor.
IlvRequestParameter(String name, boolean required, String value, boolean compared, IlvRequestParameter.Comparator operation) The constructor.

Method Summary

Modifier and Type	Method and Description
IlvRequestParameter.Comparator	getComparator() Return the comparison operation needed for parameter validation.
String	getName() Retrieve the parameter name.
String	getValue() Retrieve the default parameter value.
boolean	isCompared() Whether the parameter value should be compared with default value,the default value is false.
boolean	isRequired() Whether the parameter is required for the specific request, The default is false.
void	setComparator(IlvRequestParameter.Comparator comparator) Set the comparison operation needed for parameter validation.
void	setCompared(boolean compared) Set whether the parameter value should be compared with default value for the specific request.
void	setName(String name) Set the paramter name.
void	setRequired(boolean required) Set the parameter is required or not for the specific request
void	setValue(String value) Set the default parameter value.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvRequestParameter

public IlvRequestParameter(String name)

The constructor with parameter name. The parameter is not required default. The default parameter value is "". The parameter value do not need compare with the default value

Parameters:

name - The parameter name.

IlvRequestParameter

public IlvRequestParameter(String name,
                           boolean required)

The constructor that the default parameter value is "" and the parameter value do not need compare with default value. The constructor with parameter name and

Parameters:

name -

required -

IlvRequestParameter

public IlvRequestParameter(String name,
                           boolean required,
                           String value)

The constructor that the parameter value do not need compare with default value.

Parameters:

name - The parameter name.

required - Whether the parameter is required, the default value is false.

value - The default parameter value.

IlvRequestParameter

public IlvRequestParameter(String name,
                           boolean required,
                           String value,
                           boolean compared)

The constructor.

Parameters:

name - The parameter name.

required - Whether the parameter is required, the default value is false.

value - The default parameter value.

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

IlvRequestParameter

public IlvRequestParameter(String name,
                           boolean required,
                           String value,
                           boolean compared,
                           IlvRequestParameter.Comparator operation)

The constructor.

Parameters:

name - The parameter name.

required - Whether the parameter is required, the default value is false.

value - The default parameter value.

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

operation - The comparator operation.

Method Detail

getName

public String getName()

Retrieve the parameter name.

Returns:

parameter name.

setName

public void setName(String name)

Set the paramter name.

Parameters:

name - parameter name.

getValue

public String getValue()

Retrieve the default parameter value.

Returns:

the default parameter value.

setValue

public void setValue(String value)

Set the default parameter value.

Parameters:

value - the default parameter value.

isRequired

public boolean isRequired()

Whether the parameter is required for the specific request, The default is false.

Returns:

true if the parameter is required for the specific request, or else false.

setRequired

public void setRequired(boolean required)

Set the parameter is required or not for the specific request

Parameters:

required - Whether the parameter is required.

isCompared

public boolean isCompared()

Whether the parameter value should be compared with default value,the default value is false.

Returns:

true if the parameter should be compared with default value, or else false.

setCompared

public void setCompared(boolean compared)

Set whether the parameter value should be compared with default value for the specific request.

Parameters:

compared - The flag of compare.

getComparator

public IlvRequestParameter.Comparator getComparator()

Return the comparison operation needed for parameter validation.

Returns:

the operation needed for parameter validation.

setComparator

public void setComparator(IlvRequestParameter.Comparator comparator)

Set the comparison operation needed for parameter validation.

Parameters:

comparator - The Comparator object.