org.objectweb.telosys.common
Class RequestParameters

java.lang.Object
  extended byorg.objectweb.telosys.common.TelosysObject
      extended byorg.objectweb.telosys.common.RequestParameters
All Implemented Interfaces:
IRequestParameters
Direct Known Subclasses:
ScreenRequestParameters, ServiceRequest

public abstract class RequestParameters
extends TelosysObject
implements IRequestParameters

Generic abstract class for request parameters management.

Since:
v 1.0.2

Constructor Summary
RequestParameters()
           
 
Method Summary
 boolean getParamAsBoolean(java.lang.String paramName)
          Returns the boolean value of the given parameter name.
 boolean getParamAsBoolean(java.lang.String paramName, boolean defaultValue)
          Returns the boolean value of the given parameter name.
 byte getParamAsByte(java.lang.String paramName)
          Returns the byte value of the given parameter name.
 byte getParamAsByte(java.lang.String paramName, byte defaultValue)
          Returns the byte value of the given parameter name.
 char getParamAsChar(java.lang.String paramName)
          Returns the char value of the given parameter name.
 char getParamAsChar(java.lang.String paramName, char defaultValue)
          Returns the char value of the given parameter name.
 java.util.Date getParamAsDate(java.lang.String paramName)
          Returns the date/time/datetime value of the given parameter name.
 java.util.Date getParamAsDate(java.lang.String paramName, java.util.Date defaultValue)
          Returns the date/time/datetime value of the given parameter name.
 double getParamAsDouble(java.lang.String paramName)
          Returns the double value of the given parameter name.
 double getParamAsDouble(java.lang.String paramName, double defaultValue)
          Returns the double value of the given parameter name.
 float getParamAsFloat(java.lang.String paramName)
          Returns the float value of the given parameter name.
 float getParamAsFloat(java.lang.String paramName, float defaultValue)
          Returns the float value of the given parameter name.
 int getParamAsInt(java.lang.String paramName)
          Returns the int value of the given parameter name.
 int getParamAsInt(java.lang.String paramName, int defaultValue)
          Returns the int value of the given parameter name.
 long getParamAsLong(java.lang.String paramName)
          Returns the long value of the given parameter name.
 long getParamAsLong(java.lang.String paramName, long defaultValue)
          Returns the long value of the given parameter name.
 short getParamAsShort(java.lang.String paramName)
          Returns the short value of the given parameter name.
 short getParamAsShort(java.lang.String paramName, short defaultValue)
          Returns the short value of the given parameter name.
abstract  java.lang.String getParameter(java.lang.String paramName)
          Returns the value of the given parameter name, or NULL if not found
abstract  java.lang.String getParameter(java.lang.String paramName, java.lang.String defaultValue)
          Returns the value of the given parameter name, or the default value if not found
 
Methods inherited from class org.objectweb.telosys.common.TelosysObject
error, error, error, getFlagTrace, info, setFlagTrace, trace, warn
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.objectweb.telosys.common.IRequestParameters
getParameterMap, hasParameter
 

Constructor Detail

RequestParameters

public RequestParameters()
Method Detail

getParameter

public abstract java.lang.String getParameter(java.lang.String paramName)
Description copied from interface: IRequestParameters
Returns the value of the given parameter name, or NULL if not found

Specified by:
getParameter in interface IRequestParameters
Parameters:
paramName -
Returns:

getParameter

public abstract java.lang.String getParameter(java.lang.String paramName,
                                              java.lang.String defaultValue)
Description copied from interface: IRequestParameters
Returns the value of the given parameter name, or the default value if not found

Specified by:
getParameter in interface IRequestParameters
Parameters:
paramName -
defaultValue - : the default value used if the parameter is not found
Returns:

getParamAsBoolean

public boolean getParamAsBoolean(java.lang.String paramName)
Description copied from interface: IRequestParameters
Returns the boolean value of the given parameter name.
Throws an exception if the parameter is not found or cannot be converted.

Specified by:
getParamAsBoolean in interface IRequestParameters
Parameters:
paramName -
Returns:
true if the parameter value is "1" or "true" ( ignore case ), else false

getParamAsBoolean

public boolean getParamAsBoolean(java.lang.String paramName,
                                 boolean defaultValue)
Description copied from interface: IRequestParameters
Returns the boolean value of the given parameter name.
Returns the given default value if the parameter cannot be found.
Throws an exception if the parameter cannot be converted.

Specified by:
getParamAsBoolean in interface IRequestParameters
Parameters:
paramName -
defaultValue -
Returns:
true if the parameter value is "1" or "true" ( ignore case ), else false

getParamAsInt

public int getParamAsInt(java.lang.String paramName)
Description copied from interface: IRequestParameters
Returns the int value of the given parameter name.
Throws an exception if the parameter is not found or cannot be converted.

Specified by:
getParamAsInt in interface IRequestParameters
Parameters:
paramName -
Returns:

getParamAsInt

public int getParamAsInt(java.lang.String paramName,
                         int defaultValue)
Description copied from interface: IRequestParameters
Returns the int value of the given parameter name.
Returns the given default value if the parameter cannot be found.
Throws an exception if the parameter cannot be converted.

Specified by:
getParamAsInt in interface IRequestParameters
Parameters:
paramName -
defaultValue -
Returns:

getParamAsLong

public long getParamAsLong(java.lang.String paramName)
Description copied from interface: IRequestParameters
Returns the long value of the given parameter name.
Throws an exception if the parameter is not found or cannot be converted.

Specified by:
getParamAsLong in interface IRequestParameters
Parameters:
paramName -
Returns:

getParamAsLong

public long getParamAsLong(java.lang.String paramName,
                           long defaultValue)
Description copied from interface: IRequestParameters
Returns the long value of the given parameter name.
Returns the given default value if the parameter cannot be found.
Throws an exception if the parameter cannot be converted.

Specified by:
getParamAsLong in interface IRequestParameters
Parameters:
paramName -
defaultValue -
Returns:

getParamAsShort

public short getParamAsShort(java.lang.String paramName)
Description copied from interface: IRequestParameters
Returns the short value of the given parameter name.
Throws an exception if the parameter is not found or cannot be converted.

Specified by:
getParamAsShort in interface IRequestParameters
Parameters:
paramName -
Returns:

getParamAsShort

public short getParamAsShort(java.lang.String paramName,
                             short defaultValue)
Description copied from interface: IRequestParameters
Returns the short value of the given parameter name.
Returns the given default value if the parameter cannot be found.
Throws an exception if the parameter cannot be converted.

Specified by:
getParamAsShort in interface IRequestParameters
Parameters:
paramName -
defaultValue -
Returns:

getParamAsByte

public byte getParamAsByte(java.lang.String paramName)
Description copied from interface: IRequestParameters
Returns the byte value of the given parameter name.
Throws an exception if the parameter is not found or cannot be converted.

Specified by:
getParamAsByte in interface IRequestParameters
Parameters:
paramName -
Returns:

getParamAsByte

public byte getParamAsByte(java.lang.String paramName,
                           byte defaultValue)
Description copied from interface: IRequestParameters
Returns the byte value of the given parameter name.
Returns the given default value if the parameter cannot be found.
Throws an exception if the parameter cannot be converted.

Specified by:
getParamAsByte in interface IRequestParameters
Parameters:
paramName -
defaultValue -
Returns:

getParamAsChar

public char getParamAsChar(java.lang.String paramName)
Description copied from interface: IRequestParameters
Returns the char value of the given parameter name.
Throws an exception if the parameter is not found or cannot be converted.

Specified by:
getParamAsChar in interface IRequestParameters
Parameters:
paramName -
Returns:

getParamAsChar

public char getParamAsChar(java.lang.String paramName,
                           char defaultValue)
Description copied from interface: IRequestParameters
Returns the char value of the given parameter name.
Returns the given default value if the parameter cannot be found.
Throws an exception if the parameter cannot be converted.

Specified by:
getParamAsChar in interface IRequestParameters
Parameters:
paramName -
defaultValue -
Returns:

getParamAsFloat

public float getParamAsFloat(java.lang.String paramName)
Description copied from interface: IRequestParameters
Returns the float value of the given parameter name.
Throws an exception if the parameter is not found or cannot be converted.

Specified by:
getParamAsFloat in interface IRequestParameters
Parameters:
paramName -
Returns:

getParamAsFloat

public float getParamAsFloat(java.lang.String paramName,
                             float defaultValue)
Description copied from interface: IRequestParameters
Returns the float value of the given parameter name.
Returns the given default value if the parameter cannot be found.
Throws an exception if the parameter cannot be converted.

Specified by:
getParamAsFloat in interface IRequestParameters
Parameters:
paramName -
defaultValue -
Returns:

getParamAsDouble

public double getParamAsDouble(java.lang.String paramName)
Description copied from interface: IRequestParameters
Returns the double value of the given parameter name.
Throws an exception if the parameter is not found or cannot be converted.

Specified by:
getParamAsDouble in interface IRequestParameters
Parameters:
paramName -
Returns:

getParamAsDouble

public double getParamAsDouble(java.lang.String paramName,
                               double defaultValue)
Description copied from interface: IRequestParameters
Returns the double value of the given parameter name.
Returns the given default value if the parameter cannot be found.
Throws an exception if the parameter cannot be converted.

Specified by:
getParamAsDouble in interface IRequestParameters
Parameters:
paramName -
defaultValue -
Returns:

getParamAsDate

public java.util.Date getParamAsDate(java.lang.String paramName)
Description copied from interface: IRequestParameters
Returns the date/time/datetime value of the given parameter name.
Throws an exception if the parameter is not found or cannot be converted.

Specified by:
getParamAsDate in interface IRequestParameters
Parameters:
paramName -
Returns:

getParamAsDate

public java.util.Date getParamAsDate(java.lang.String paramName,
                                     java.util.Date defaultValue)
Description copied from interface: IRequestParameters
Returns the date/time/datetime value of the given parameter name.
Returns the given default value if the parameter cannot be found.
Throws an exception if the parameter cannot be converted.

Specified by:
getParamAsDate in interface IRequestParameters
Parameters:
paramName -
defaultValue -
Returns: