org.objectweb.telosys.rpl
Class ScreenRequestParameters

java.lang.Object
  extended byorg.objectweb.telosys.common.TelosysObject
      extended byorg.objectweb.telosys.common.RequestParameters
          extended byorg.objectweb.telosys.rpl.ScreenRequestParameters
All Implemented Interfaces:
IRequestParameters

public class ScreenRequestParameters
extends RequestParameters

Parameters embeded in a ScreenRequest (parameters sent by a 'screen action')
or parameters received in events 'eventCreate' or 'eventReuse'


Constructor Summary
ScreenRequestParameters()
          Creates a void parameters collection
ScreenRequestParameters(java.util.Map map)
          Creates a parameters collection and initializes it with the given HttpServletRequest parameters map
 
Method Summary
 int count()
          Return the number of parameters
 int getIntParameter(java.lang.String sParamName)
          Deprecated. use getParamAsInt
 int getIntParameter(java.lang.String sParamName, int iDefaultValue)
          Deprecated. use getParamAsInt
 java.lang.String getParameter(java.lang.String sParamName)
          Returns the value of the given parameter name, or NULL if not found
 java.lang.String getParameter(java.lang.String sParamName, java.lang.String sDefaultValue)
          Returns the value of the given parameter name, or the default value if not found
 java.util.Map getParameterMap()
          Returns the parameters as a Map instance
 boolean hasParameter()
          Returns true if there's at least one parameter in the request
 void setParameter(java.lang.String sParamName, java.lang.String sParamValue)
          Set a parameter with its value
 java.lang.String toString()
           
 
Methods inherited from class org.objectweb.telosys.common.RequestParameters
getParamAsBoolean, getParamAsBoolean, getParamAsByte, getParamAsByte, getParamAsChar, getParamAsChar, getParamAsDate, getParamAsDate, getParamAsDouble, getParamAsDouble, getParamAsFloat, getParamAsFloat, getParamAsInt, getParamAsInt, getParamAsLong, getParamAsLong, getParamAsShort, getParamAsShort
 
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, wait, wait, wait
 

Constructor Detail

ScreenRequestParameters

public ScreenRequestParameters()
Creates a void parameters collection


ScreenRequestParameters

public ScreenRequestParameters(java.util.Map map)
Creates a parameters collection and initializes it with the given HttpServletRequest parameters map

Parameters:
map -
Method Detail

getParameterMap

public java.util.Map getParameterMap()
Returns the parameters as a Map instance

Returns:
Since:
1.1.0

setParameter

public void setParameter(java.lang.String sParamName,
                         java.lang.String sParamValue)
Set a parameter with its value

Parameters:
sParamName -
sParamValue -

getParameter

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

Specified by:
getParameter in interface IRequestParameters
Specified by:
getParameter in class RequestParameters

hasParameter

public boolean hasParameter()
Description copied from interface: IRequestParameters
Returns true if there's at least one parameter in the request

Returns:

getParameter

public java.lang.String getParameter(java.lang.String sParamName,
                                     java.lang.String sDefaultValue)
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
Specified by:
getParameter in class RequestParameters

getIntParameter

public int getIntParameter(java.lang.String sParamName)
                    throws TelosysException
Deprecated. use getParamAsInt

Returns the int value of the given parameter name

Parameters:
sParamName -
Returns:
Throws:
TelosysException - : if parameter not found or not convertible to int

getIntParameter

public int getIntParameter(java.lang.String sParamName,
                           int iDefaultValue)
                    throws TelosysException
Deprecated. use getParamAsInt

Returns the int value of the given parameter name, or the default value if not found

Parameters:
sParamName -
iDefaultValue -
Returns:
Throws:
TelosysException - : if the parameter value is not convertible to int

count

public int count()
Return the number of parameters

Returns:
parameters count ( 0 to N )

toString

public java.lang.String toString()