ifs.fnd.gateway

Class QueryStringParameters

java.lang.Object

ifs.fnd.gateway.QueryStringParameters

public class QueryStringParameters
extends java.lang.Object

Query string parameter parser

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryStringParameters.ParamDef Inner class defining parameter and holding its value
static class	QueryStringParameters.Types

Constructor Summary

Constructors

Constructor and Description
QueryStringParameters(javax.servlet.http.HttpServletRequest request, Logger log) Constructs new instance of parser

Method Summary

Modifier and Type	Method and Description
boolean	getBoolValue(java.lang.String name) Get value of a given parameter as boolean.
int	getIntValue(java.lang.String name) Get value of a given parameter as integer.
QueryStringParameters.ParamDef	getParameter(java.lang.String name) Get instance of the inner class ParamDef representing a parameter.
java.lang.String	getParameterString() Returns a complete parameter string.
java.lang.String	getStringValue(java.lang.String name) Get value of a given parameter as string.
boolean	isParameterSet(java.lang.String name) Checks if parameter value has been set.
int	parse() Parse the query string.
QueryStringParameters.ParamDef	reqisterParameter(java.lang.String name, QueryStringParameters.Types type) Register a new parameter
QueryStringParameters.ParamDef	reqisterParameter(java.lang.String name, QueryStringParameters.Types type, boolean caseSensitive) Register a new parameter.
void	setRule(int ruleNo, java.lang.String... names) Define a rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryStringParameters

public QueryStringParameters(javax.servlet.http.HttpServletRequest request,
                             Logger log)
                      throws SystemException

Constructs new instance of parser

Parameters:

request - HttpServletRequest to read parameters from

log - instance of Logger

Throws:

SystemException

Method Detail

reqisterParameter

public QueryStringParameters.ParamDef reqisterParameter(java.lang.String name,
                                                        QueryStringParameters.Types type)
                                                 throws SystemException

Register a new parameter

Parameters:

name - Name of parameter to register

type - Type of the parameter

Returns:

Instance of inner class ParamDef holding parameter definition

Throws:

SystemException

reqisterParameter

public QueryStringParameters.ParamDef reqisterParameter(java.lang.String name,
                                                        QueryStringParameters.Types type,
                                                        boolean caseSensitive)
                                                 throws SystemException

Register a new parameter. Even if parameters are set to be case sensitive, it is not allowed to have two or more parameters having the same representation after conversion to lower case.

Parameters:

name - Name of parameter to register

type - Type of the parameter

caseSensitive - 'true' if the parameter name has to be case sensitive

Returns:

Instance of inner class ParamDef holding parameter definition

Throws:

SystemException

setRule

public void setRule(int ruleNo,
                    java.lang.String... names)
             throws SystemException

Define a rule. A rule has always a unique number and defines combination parameter names that can be present at the same time. Order of parameters is undefined.

Parameters:

ruleNo - Unique number for this rule

names - Zero or more parameter names

Throws:

SystemException

parse

public int parse()
          throws SystemException

Parse the query string. This is not allowed to have multiple parameters with the same name. A parameter of BOOL type can have one of following values, irrespective of case: on, off, true, false, yes, no. A parameter of EXISTS can have one of following values, irrespective of case, on not have any value at all: on, true, yes. Parameter order can be arbitrary.

Returns:

A rule number corresponding to the actual parameter combination.

Throws:

SystemException

getParameter

public QueryStringParameters.ParamDef getParameter(java.lang.String name)
                                            throws SystemException

Get instance of the inner class ParamDef representing a parameter.

Parameters:

name - Parameter name

Returns:

Instance of ParamDef

Throws:

SystemException

getStringValue

public java.lang.String getStringValue(java.lang.String name)
                                throws SystemException

Get value of a given parameter as string. Parameter type must be STRING and value must be set.

Parameters:

name - Parameter name

Returns:

Value of the parameter

Throws:

SystemException

getIntValue

public int getIntValue(java.lang.String name)
                throws SystemException

Get value of a given parameter as integer. Parameter type must be INT and value must be set.

Parameters:

name - Parameter name

Returns:

Value of the parameter

Throws:

SystemException

getBoolValue

public boolean getBoolValue(java.lang.String name)
                     throws SystemException

Get value of a given parameter as boolean. Parameter type must be BOOL and value must be set.

Parameters:

name - Parameter name

Returns:

Value of the parameter

Throws:

SystemException

isParameterSet

public boolean isParameterSet(java.lang.String name)

Checks if parameter value has been set.

Parameters:

name - Parameter name

Returns:

'true' if value has been set

getParameterString

public java.lang.String getParameterString()

Returns a complete parameter string. Can be used for redirections.

Returns:

query parameter string