www.element4solution.com

e4s.html
Class E4CgiParams

java.lang.Object
  extended by e4s.util.E4Object
      extended by e4s.html.E4CgiParams

public class E4CgiParams
extends E4Object

Handling of parameters between CGI calls. This is propably one of the most important classes in this library, as it holds all the parameters passed to a function call or collected by a <FORM>-tag.

Since:
JDK 1.4
See Also:
FORM, A

Field Summary
static java.text.SimpleDateFormat DATEFORMAT
          This is the internal date format how parameters are handled
static char NAME_SEPERATOR
          In the case of a DATEFIELD input field, the name of the field is automatically extended by this NAME_SEPERATOR sign and an alias definition for the format.
 
Fields inherited from class e4s.util.E4Object
CRLF, E4S_CORE_SYSTEM_LANGUAGE, NBSP, NULLSTR, URL_ENCODING_CHARSET
 
Constructor Summary
E4CgiParams()
           
E4CgiParams(E4CgiParams p)
           
 
Method Summary
static java.lang.String _getSVNVersionString()
           
 void add(E4CgiParams params)
          Adds a list of parameters.
 void add(E4InputFieldName_Intf paramname, boolean value)
          Add a parameter to the parameter list.
 void add(E4InputFieldName_Intf paramname, java.util.Calendar value)
          Add a parameter to the parameter list.
 void add(E4InputFieldName_Intf paramname, java.util.Date value)
          Add a parameter to the parameter list.
 void add(E4InputFieldName_Intf paramname, E4Long value)
          Add a parameter to the parameter list.
 void add(E4InputFieldName_Intf paramname, E4String value)
          Add a parameter to the parameter list.
 void add(E4InputFieldName_Intf paramname, float value)
          Add a parameter to the parameter list.
 void add(E4InputFieldName_Intf paramname, int value)
          Add a parameter to the parameter list.
 void add(E4InputFieldName_Intf paramname, long value)
          Add a parameter to the parameter list.
 void add(E4InputFieldName_Intf paramname, java.lang.String value)
          Add a parameter to the parameter list.
 void add(java.lang.String paramname, boolean value)
          Add a parameter to the parameter list.
 void add(java.lang.String paramname, boolean[] value)
          Add a parameter to the parameter list.
 void add(java.lang.String paramname, java.util.Calendar value)
          Add a parameter to the parameter list.
 void add(java.lang.String paramname, java.util.Date value)
          Add a parameter to the parameter list.
 void add(java.lang.String paramname, E4Long value)
          Add a parameter to the parameter list.
 void add(java.lang.String paramname, E4String value)
          Add a parameter to the parameter list.
 void add(java.lang.String paramname, float value)
          Add a parameter to the parameter list.
 void add(java.lang.String paramname, int value)
          Add a parameter to the parameter list.
 void add(java.lang.String paramname, int[] value)
          Add a parameter to the parameter list.
 void add(java.lang.String paramname, long value)
          Add a parameter to the parameter list.
 void add(java.lang.String paramname, long[] value)
          Add a parameter to the parameter list.
 void add(java.lang.String paramname, java.lang.String value)
          Add a parameter to the parameter list.
 void add(java.lang.String paramname, java.lang.String[] value)
          Add a parameter to the parameter list.
 void addObj(java.lang.Object obj, java.lang.String alias)
          Sets a parameter for each member variable of obj beginning with "m_".
 void addObjectReference(java.lang.Object obj, java.lang.String paramname, E4ServletImplementation_Intf servlet)
          Deprecated.  
 void addObjectReference(java.lang.String paramname, java.lang.Object obj, E4ServletImplementation_Intf servlet)
           
 void addParameter(E4CgiParams params)
          Deprecated.  
 void addParameter(E4InputFieldName_Intf paramname, boolean value)
          Deprecated.  
 void addParameter(E4InputFieldName_Intf paramname, java.util.Calendar value)
          Deprecated.  
 void addParameter(E4InputFieldName_Intf paramname, java.util.Date value)
          Deprecated.  
 void addParameter(E4InputFieldName_Intf paramname, E4Long value)
          Deprecated.  
 void addParameter(E4InputFieldName_Intf paramname, E4String value)
          Deprecated.  
 void addParameter(E4InputFieldName_Intf paramname, float value)
          Deprecated.  
 void addParameter(E4InputFieldName_Intf paramname, int value)
          Deprecated.  
 void addParameter(E4InputFieldName_Intf paramname, long value)
          Deprecated.  
 void addParameter(E4InputFieldName_Intf paramname, java.lang.String value)
          Add a parameter to the parameter list.
 void addParameter(java.lang.String paramname, boolean value)
          Deprecated.  
 void addParameter(java.lang.String paramname, java.util.Calendar value)
          Deprecated.  
 void addParameter(java.lang.String paramname, java.util.Date value)
          Deprecated.  
 void addParameter(java.lang.String paramname, E4String value)
          Deprecated.  
 void addParameter(java.lang.String paramname, float value)
          Deprecated.  
 void addParameter(java.lang.String paramname, int value)
          Deprecated.  
 void addParameter(java.lang.String paramname, long value)
          Deprecated.  
 void addParameter(java.lang.String paramname, java.lang.String value)
          Deprecated.  
 void addParameter(java.lang.String paramname, java.lang.String[] value)
          Deprecated.  
 void addParameterObj(java.lang.Object obj, java.lang.String alias)
          Deprecated.  
 void addTimestamp()
          Adds a timestamp parameter to guarantee unique new parameters and avoid caching of browsers or proxies.
 E4Label_Intf checkBool(E4InputFieldName_Intf paramname)
          Checks, if a boolean parameter has any error.
 E4Label_Intf checkBool(java.lang.String paramname)
          Checks, if a boolean parameter has any error.
 E4Label_Intf checkDate(E4InputFieldName_Intf paramname)
          Checks, if a date parameter has any error.
 E4Label_Intf checkDate(E4InputFieldName_Intf paramname, boolean mandatory)
          Checks, if a date parameter has any error.
 E4Label_Intf checkDate(java.lang.String paramname)
          Checks, if a date parameter has any error.
 E4Label_Intf checkDate(java.lang.String paramname, boolean mandatory)
          Checks, if a date parameter has any error.
 E4Label_Intf checkFloat(E4InputFieldName_Intf paramname)
          Checks, if a long parameter has any error.
 E4Label_Intf checkFloat(E4InputFieldName_Intf paramname, float min_value, float max_value)
          Checks, if a long parameter has any error.
 E4Label_Intf checkFloat(java.lang.String paramname)
          Checks, if a long parameter has any error.
 E4Label_Intf checkFloat(java.lang.String paramname, float min_value, float max_value)
          Checks, if a long parameter has any error.
 E4Label_Intf checkInt(E4InputFieldName_Intf paramname)
          Checks, if a long parameter has any error.
 E4Label_Intf checkInt(java.lang.String paramname)
          Checks, if a long parameter has any error.
 E4Label_Intf checkLong(E4InputFieldName_Intf paramname)
          Checks, if a long parameter has any error.
 E4Label_Intf checkLong(java.lang.String paramname)
          Checks, if a long parameter has any error.
 E4Label_Intf checkParameterBool(E4InputFieldName_Intf paramname)
          Deprecated.  
 E4Label_Intf checkParameterBool(java.lang.String paramname)
          Deprecated.  
 E4Label_Intf checkParameterDate(E4InputFieldName_Intf paramname)
          Deprecated.  
 E4Label_Intf checkParameterDate(java.lang.String paramname)
          Deprecated.  
 E4Label_Intf checkParameterInt(E4InputFieldName_Intf paramname)
          Deprecated.  
 E4Label_Intf checkParameterInt(java.lang.String paramname)
          Deprecated.  
 E4Label_Intf checkParameterLong(E4InputFieldName_Intf paramname)
          Deprecated.  
 E4Label_Intf checkParameterLong(java.lang.String paramname)
          Deprecated.  
 java.lang.Object clone()
          Clone the parameters.
 E4CgiParams copy()
          Same as clone()
 java.lang.String get(E4InputFieldName_Intf paramname)
          Get the parameter from the list.
 java.lang.String get(E4InputFieldName_Intf paramname, boolean throw_exception)
          Get the parameter from the list..
 void get(java.lang.Object obj, java.lang.String alias)
          Gets a parameter for each member variable of obj beginning with "m_".
 java.lang.String get(java.lang.String paramname)
          Get the parameter from the list, same as get(java.lang.String).
 java.lang.String get(java.lang.String paramname, boolean throw_exception)
          Get the parameter from the list.
 java.lang.Object getAndRemoveObjectReference(java.lang.String paramname, boolean remove, E4ServletImplementation_Intf servlet)
          Get a object that was used as a parameter before.
 java.lang.Object getAndRemoveObjectReference(java.lang.String paramname, E4ServletImplementation_Intf servlet)
          Get a object that was used as a parameter before.
 java.lang.String[] getArray(java.lang.String baseparamname)
          Get the parameter from the list.
 boolean[] getArrayBool(java.lang.String baseparamname)
          Get the parameter from the list.
 long[] getArrayLong(java.lang.String baseparamname)
          Get the parameter from the list.
 boolean getBool(E4InputFieldName_Intf paramname)
          Get the parameter from the list.
 boolean getBool(java.lang.String paramname)
          Get the parameter from the list.
 char getChar(E4InputFieldName_Intf paramname)
          Get the parameter from the list.
 java.util.Date getDate(E4InputFieldName_Intf paramname)
          Get the parameter from the list.
 java.util.Date getDate(java.lang.String paramname)
          Get the parameter from the list.
 java.util.Calendar getDateC(E4InputFieldName_Intf paramname)
          Get the parameter from the parameter list.
 java.util.Date getDateNoException(E4InputFieldName_Intf paramname)
          Get the parameter from the list.
 float getFloat(E4InputFieldName_Intf paramname)
          Get the parameter from the list.
 float getFloat(E4InputFieldName_Intf paramname, E4DecimalSign decimal)
          Get the parameter from the list.
 float getFloat(java.lang.String paramname)
          Get the parameter from the list.
 float getFloat(java.lang.String paramname, char decimalsign)
          Get the parameter from the list.
 float getFloat(java.lang.String paramname, E4DecimalSign decimal)
          Get the parameter from the list.
static java.lang.String getFormatPicture(java.lang.String paramname)
          Extract the dateformat from a paramname.
 int getInt(E4InputFieldName_Intf paramname)
          Get the parameter from the list.
 int getInt(java.lang.String paramname)
          Get the parameter from the list.
 Language getLanguage(E4InputFieldName_Intf paramname, Language defaultLanguage, Language[] possibleLanguages)
          Get a value as Language.
 Language getLanguage(java.lang.String paramname, Language defaultLanguage, Language[] possibleLanguages)
          Get a value as Language.
 long getLong(E4InputFieldName_Intf paramname)
          Get the parameter from the list.
 long getLong(java.lang.String paramname)
          Get the parameter from the list.
 java.lang.String[] getNames()
          Get the parameter names as array.
 java.lang.String getParameter(E4InputFieldName_Intf paramname)
          Deprecated.  
 void getParameter(java.lang.Object obj, java.lang.String alias)
          Deprecated.  
 java.lang.String getParameter(java.lang.String paramname)
          Deprecated.  
 java.lang.String[] getParameterArray(java.lang.String baseparamname)
          Deprecated.  
 boolean getParameterBool(E4InputFieldName_Intf paramname)
          Deprecated.  
 boolean getParameterBool(java.lang.String paramname)
          Deprecated.  
 java.util.Date getParameterDate(E4InputFieldName_Intf paramname)
          Deprecated.  
 java.util.Date getParameterDate(java.lang.String paramname)
          Deprecated.  
 float getParameterFloat(E4InputFieldName_Intf paramname)
          Deprecated.  
 float getParameterFloat(E4InputFieldName_Intf paramname, E4DecimalSign decimal)
          Deprecated.  
 float getParameterFloat(java.lang.String paramname)
          Deprecated.  
 float getParameterFloat(java.lang.String paramname, char decimalsign)
          Deprecated.  
 float getParameterFloat(java.lang.String paramname, E4DecimalSign decimal)
          Deprecated.  
 int getParameterInt(E4InputFieldName_Intf paramname)
          Deprecated.  
 int getParameterInt(java.lang.String paramname)
          Deprecated.  
 long getParameterLong(E4InputFieldName_Intf paramname)
          Deprecated.  
 long getParameterLong(java.lang.String paramname)
          Deprecated.  
 java.util.Enumeration getParameters()
          Get the parameter list.
 boolean isParameter(E4InputFieldName_Intf paramname)
          Check the existence of a parameter.
 boolean isParameter(java.lang.String paramname)
          Check the existence of a parameter.
 void remove(E4InputFieldName_Intf name)
          Remove the specified parameter.
 void remove(java.lang.String name)
          Remove the specified parameter.
 void removeAll()
          Clears all parameters
 void removeParameter(E4InputFieldName_Intf name)
          Deprecated.  
 void removeParameter(java.lang.String name)
          Deprecated.  
 int size()
          Get the size (number of elements) in the parameters object.
 java.lang.String toCgiCall()
          Concatenate the parameters in the Cgi style.
 void toHIDDENFIELD(FORM form)
          Same implementation as FORM.toHIDDENFIELD(e4s.html.E4CgiParams)
 void toHIDDENFIELD(FORM form, E4InputFieldName_Intf[] except)
          Same implementation as FORM.toHIDDENFIELD(e4s.html.E4CgiParams, e4s.html.input.extended.E4InputFieldName_Intf[])
 java.lang.String toString()
          Build a list with >CR<>LF%lt; at the end of each line.
 java.lang.String toString(java.lang.String delimiter)
          Build a string with all parameters.
 void toTable(TABLE table)
           
 void toTable(TABLE table, java.lang.String header)
           
 
Methods inherited from class e4s.util.E4Object
Calendar, CName, CName, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelApp, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelNone, E4LabelSys, E4LabelSys, e4sCopyright, e4sVersion, encode, encode, encode, encodeHtml, encodeHtml, encodeHtml, encodeURL, encodeURL, encodeURL, finalize, getLINE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTRACE, getTraceMemory, HtmlEncode, HtmlEncode, HtmlEncode, isdecimal, isdigit, isnotok, isnotok, isnumeric, isok, isok, isok, isok, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingFunction, lastCallingStack, mkdirs, null2nbsp, null2nbsp, null2nbsp, ok, ok, ok, ok, outPrintln, setLogFile4Trace, setTraceMemory, STACKTRACE, toDebug, toDouble, toFloat, toFloat, TRACE_CALLS, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, TRACE, wait
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DATEFORMAT

public static final java.text.SimpleDateFormat DATEFORMAT
This is the internal date format how parameters are handled


NAME_SEPERATOR

public static char NAME_SEPERATOR
In the case of a DATEFIELD input field, the name of the field is automatically extended by this NAME_SEPERATOR sign and an alias definition for the format. The alias definition is a integer value, created by DATEFIELD.getFormatAlias(String) and stored in a static Vector in class DATEFIELD internally. To get the dateformat (picture), the fieldname is cut off into two parts: the real fieldname and the alias definition for the picture. Then this alias definition is translated back into the real date picture, using DATEFIELD.getFormatPicture(int).

See Also:
DATEFIELD.getFormatAlias(String), DATEFIELD.getFormatPicture(int), getFormatPicture(java.lang.String), DATEFIELD.getHtmlParamName(boolean)
Constructor Detail

E4CgiParams

public E4CgiParams()

E4CgiParams

public E4CgiParams(E4CgiParams p)
Method Detail

addParameter

public void addParameter(java.lang.String paramname,
                         java.lang.String value)
Deprecated. 


add

public void add(java.lang.String paramname,
                java.lang.String value)
Add a parameter to the parameter list. Note that the listing is not case sensitive. DATEFIELD only: If a parametername contains a #, it is expected that behind the name the date/time format is specified (e.g. "DATE#dd.MM.yy"). In such cases, the dateformat is extracted from the parameter name, the value is converted to a java.util.Date value and the parameter name is extracted to the characters before, not including, the # mark. Similar effect as a call to addParameter(String,java.util.Date) would have been made. Reason: when a date field is displayed on the screen for user input, the CGI mechanism just stores the value as String and cannot determine that this has original been a date representation.

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter

addParameter

public void addParameter(E4InputFieldName_Intf paramname,
                         java.lang.String value)
Add a parameter to the parameter list. Note that the listing is not case sensitive. DATEFIELD only: If a parametername contains a #, it is expected that behind the name the date/time format is specified (e.g. "DATE#dd.MM.yy"). In such cases, the dateformat is extracted from the parameter name, the value is converted to a java.util.Date value and the parameter name is extracted to the characters before, not including, the # mark. Similar effect as a call to addParameter(String,java.util.Date) would have been made. Reason: when a date field is displayed on the screen for user input, the CGI mechanism just stores the value as String and cannot determine that this has original been a date representation.

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter

addParameter

public void addParameter(E4InputFieldName_Intf paramname,
                         E4String value)
Deprecated. 

See Also:
add(E4InputFieldName_Intf, E4String)

add

public void add(E4InputFieldName_Intf paramname,
                E4String value)
Add a parameter to the parameter list. Note that the listing is not case sensitive.

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter
See Also:
add(E4InputFieldName_Intf,String)

add

public void add(E4InputFieldName_Intf paramname,
                java.lang.String value)
Add a parameter to the parameter list. Note that the listing is not case sensitive.

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter
See Also:
add(E4InputFieldName_Intf,String)

add

public void add(java.lang.String paramname,
                E4String value)
Add a parameter to the parameter list. Note that the listing is not case sensitive.

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter
See Also:
add(E4InputFieldName_Intf,String)

addParameter

public void addParameter(E4InputFieldName_Intf paramname,
                         E4Long value)
Deprecated. 

See Also:
add(E4InputFieldName_Intf, E4Long)

add

public void add(E4InputFieldName_Intf paramname,
                E4Long value)
Add a parameter to the parameter list. Note that the listing is not case sensitive.

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter
See Also:
add(E4InputFieldName_Intf,String)

addParameter

public void addParameter(java.lang.String paramname,
                         E4String value)
Deprecated. 


addParameter

public void addParameter(java.lang.String paramname,
                         java.lang.String[] value)
Deprecated. 


add

public void add(java.lang.String paramname,
                java.lang.String[] value)
Add a parameter to the parameter list. Note that the listing is not case sensitive. In this case, the parameternames is appended by a [n] for representing the array.

Parameters:
paramname - the name of the parameter
value - array with values for the parameter. A value of null removes the parameter
See Also:
getArray(String)

add

public void add(java.lang.String paramname,
                long[] value)
Add a parameter to the parameter list. Note that the listing is not case sensitive. In this case, the parameternames is appended by a [n] for representing the array.

Parameters:
paramname - the name of the parameter
value - array with values for the parameter. A value of null removes the parameter
See Also:
getArrayLong(String)

add

public void add(java.lang.String paramname,
                int[] value)
Add a parameter to the parameter list. Note that the listing is not case sensitive. In this case, the parameternames is appended by a [n] for representing the array.

Parameters:
paramname - the name of the parameter
value - array with values for the parameter. A value of null removes the parameter
See Also:
getArrayLong(String)

add

public void add(java.lang.String paramname,
                boolean[] value)
Add a parameter to the parameter list. Note that the listing is not case sensitive. In this case, the parameternames is appended by a [n] for representing the array.

Parameters:
paramname - the name of the parameter
value - array with values for the parameter. A value of null removes the parameter
See Also:
getArrayBool(String)

addParameter

public void addParameter(java.lang.String paramname,
                         int value)
Deprecated. 


add

public void add(java.lang.String paramname,
                int value)
Add a parameter to the parameter list. Note that the listing is not case sensitive

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter

addParameter

public void addParameter(E4InputFieldName_Intf paramname,
                         int value)
Deprecated. 

See Also:
add(E4InputFieldName_Intf,int)

add

public void add(E4InputFieldName_Intf paramname,
                int value)
Add a parameter to the parameter list. Note that the listing is not case sensitive

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter

addParameter

public void addParameter(java.lang.String paramname,
                         java.util.Calendar value)
Deprecated. 


add

public void add(java.lang.String paramname,
                java.util.Calendar value)
Add a parameter to the parameter list. Note that the listing is not case sensitive

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter

addParameter

public void addParameter(java.lang.String paramname,
                         java.util.Date value)
Deprecated. 


add

public void add(java.lang.String paramname,
                java.util.Date value)
Add a parameter to the parameter list. Note that the listing is not case sensitive

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter

addParameter

public void addParameter(E4InputFieldName_Intf paramname,
                         java.util.Calendar value)
Deprecated. 

See Also:
add(E4InputFieldName_Intf, Calendar)

add

public void add(E4InputFieldName_Intf paramname,
                java.util.Calendar value)
Add a parameter to the parameter list. Note that the listing is not case sensitive

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter

addParameter

public void addParameter(E4InputFieldName_Intf paramname,
                         java.util.Date value)
Deprecated. 

See Also:
add(E4InputFieldName_Intf,Date)

add

public void add(E4InputFieldName_Intf paramname,
                java.util.Date value)
Add a parameter to the parameter list. Note that the listing is not case sensitive

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter

addParameter

public void addParameter(java.lang.String paramname,
                         long value)
Deprecated. 


add

public void add(java.lang.String paramname,
                long value)
Add a parameter to the parameter list. Note that the listing is not case sensitive

Parameters:
paramname - the name of the parameter
value - the value for the parameter.

add

public void add(java.lang.String paramname,
                E4Long value)
Add a parameter to the parameter list. Note that the listing is not case sensitive

Parameters:
paramname - the name of the parameter
value - the value for the parameter.

addParameter

public void addParameter(E4InputFieldName_Intf paramname,
                         long value)
Deprecated. 


add

public void add(E4InputFieldName_Intf paramname,
                long value)
Add a parameter to the parameter list. Note that the listing is not case sensitive

Parameters:
paramname - the name of the parameter
value - the value for the parameter.

addParameter

public void addParameter(java.lang.String paramname,
                         float value)
Deprecated. 


add

public void add(java.lang.String paramname,
                float value)
Add a parameter to the parameter list. Note that the listing is not case sensitive

Parameters:
paramname - the name of the parameter
value - the value for the parameter.

addParameter

public void addParameter(E4InputFieldName_Intf paramname,
                         float value)
Deprecated. 

See Also:
add(E4InputFieldName_Intf,float)

add

public void add(E4InputFieldName_Intf paramname,
                float value)
Add a parameter to the parameter list. Note that the listing is not case sensitive

Parameters:
paramname - the name of the parameter
value - the value for the parameter.

addParameter

public void addParameter(java.lang.String paramname,
                         boolean value)
Deprecated. 


add

public void add(java.lang.String paramname,
                boolean value)
Add a parameter to the parameter list. Note that the listing is not case sensitive

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter

addParameter

public void addParameter(E4InputFieldName_Intf paramname,
                         boolean value)
Deprecated. 

See Also:
add(e4s.html.input.extended.E4InputFieldName_Intf,boolean)

add

public void add(E4InputFieldName_Intf paramname,
                boolean value)
Add a parameter to the parameter list. Note that the listing is not case sensitive

Parameters:
paramname - the name of the parameter
value - the value for the parameter. A value of null removes the parameter

addParameter

public void addParameter(E4CgiParams params)
Deprecated. 

See Also:
add(e4s.html.E4CgiParams)

add

public void add(E4CgiParams params)
Adds a list of parameters.

Parameters:
params - a list of parameters

addParameterObj

public void addParameterObj(java.lang.Object obj,
                            java.lang.String alias)
Deprecated. 

See Also:
addObj(Object,String)

addObj

public void addObj(java.lang.Object obj,
                   java.lang.String alias)
Sets a parameter for each member variable of obj beginning with "m_". Note, that each paramater must begin with an (case-sensitive) "m_" and be declared public. A valid definition would be: public class X { public String m_color = "red"; public int m_counter = 1; public long m_timer = 902109823; public boolean m_flag = true; private String m_ignore_a = "test"; public String ignore_b = "test"; } and a call to addParameter(new X(),"TEST") would result in addParameter("TEST_M_COLOR","red"); addParameter("TEST_M_FLAG",true); addParameter("TEST_M_COUNTER",1); addParameter("TEST_M_TIMER",902109823); Each parameter is stored as [alias].[fieldname]. Implementation for String, int, long and boolean members only!!

Parameters:
obj - the object
alias - an alias name for the object

addObjectReference

public void addObjectReference(java.lang.Object obj,
                               java.lang.String paramname,
                               E4ServletImplementation_Intf servlet)
                        throws java.lang.Exception
Deprecated. 

Throws:
java.lang.Exception
See Also:
addObjectReference( String, Object, e4s.servlet.E4ServletImplementation_Intf )

addObjectReference

public void addObjectReference(java.lang.String paramname,
                               java.lang.Object obj,
                               E4ServletImplementation_Intf servlet)
                        throws java.lang.Exception
Throws:
java.lang.Exception

getAndRemoveObjectReference

public java.lang.Object getAndRemoveObjectReference(java.lang.String paramname,
                                                    E4ServletImplementation_Intf servlet)
Get a object that was used as a parameter before. This mechanism works using the session-objects, related to each session. Exactly, this is not treatened as an CGI parameter. It is intended to handle complex parameters, but keep in mind that this will need memory. Object will be removed, no further access will be possible to this parameter.

Parameters:
paramname - the name of the parameter
servlet - the servlet's context
See Also:
getAndRemoveObjectReference( String, boolean, E4ServletImplementation_Intf ), e4s.servlet.E4ServletImplementation_Intf.getSession(), addObjectReference(java.lang.Object, java.lang.String, e4s.servlet.E4ServletImplementation_Intf)

getAndRemoveObjectReference

public java.lang.Object getAndRemoveObjectReference(java.lang.String paramname,
                                                    boolean remove,
                                                    E4ServletImplementation_Intf servlet)
Get a object that was used as a parameter before. This mechanism works using the session-objects, related to each session. Exactly, this is not treatened as an CGI parameter. It is intended to handle complex parameters, but keep in mind that this will need memory.

Parameters:
paramname - the name of the parameter
remove - if true, then the object is removed immediatly, no second access will be possible
servlet - the servlet's context
See Also:
getAndRemoveObjectReference( String, boolean, E4ServletImplementation_Intf ), E4ServletImplementation_Intf.getSession(), addObjectReference(String,Object,e4s.servlet.E4ServletImplementation_Intf)

isParameter

public boolean isParameter(java.lang.String paramname)
Check the existence of a parameter.

Parameters:
paramname - the parameter name to check
Returns:
true: if this parameter is defined and has a value != ''
See Also:
get(String)

isParameter

public boolean isParameter(E4InputFieldName_Intf paramname)
Check the existence of a parameter.

Parameters:
paramname - the parameter name to check
Returns:
true: if this parameter is defined and has a value != ''
See Also:
get(String)

getParameter

public java.lang.String getParameter(java.lang.String paramname)
Deprecated. 

See Also:
get(String)

get

public java.lang.String get(java.lang.String paramname)
Get the parameter from the list, same as get(java.lang.String). On the result value a String.trim() is performed.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or null if not available
See Also:
get(String)

get

public java.lang.String get(java.lang.String paramname,
                            boolean throw_exception)
                     throws E4CgiParamsException
Get the parameter from the list. On the result value a String.trim() is performed.

Parameters:
paramname - name of the parameter to look for
throw_exception - true: throw an exception if parameter is not defined or empty
Returns:
the value for paramname or null if not available
Throws:
E4CgiParamsException
See Also:
get(String), get(String)

getParameter

public java.lang.String getParameter(E4InputFieldName_Intf paramname)
Deprecated. 

See Also:
get(e4s.html.input.extended.E4InputFieldName_Intf)

get

public java.lang.String get(E4InputFieldName_Intf paramname)
Get the parameter from the list. On the result value a String.trim() is performed.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or null if not available
See Also:
get(e4s.html.input.extended.E4InputFieldName_Intf), get(e4s.html.input.extended.E4InputFieldName_Intf,boolean), get(String)

get

public java.lang.String get(E4InputFieldName_Intf paramname,
                            boolean throw_exception)
                     throws E4CgiParamsException
Get the parameter from the list.. On the result value a String.trim() is performed.

Parameters:
paramname - name of the parameter to look for
throw_exception - true: throw an exception if parameter is not defined or empty
Returns:
the value for paramname or null if not available
Throws:
E4CgiParamsException
See Also:
get(e4s.html.input.extended.E4InputFieldName_Intf), get(String)

getParameterBool

public boolean getParameterBool(java.lang.String paramname)
Deprecated. 

See Also:
getBool(String)

getBool

public boolean getBool(java.lang.String paramname)
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or false if not available

getParameterBool

public boolean getParameterBool(E4InputFieldName_Intf paramname)
Deprecated. 

See Also:
getBool(e4s.html.input.extended.E4InputFieldName_Intf)

getBool

public boolean getBool(E4InputFieldName_Intf paramname)
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or false if not available

getChar

public char getChar(E4InputFieldName_Intf paramname)
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or false if not available

checkParameterDate

public E4Label_Intf checkParameterDate(E4InputFieldName_Intf paramname)
Deprecated. 

See Also:
checkDate(e4s.html.input.extended.E4InputFieldName_Intf)

checkDate

public E4Label_Intf checkDate(E4InputFieldName_Intf paramname)
Checks, if a date parameter has any error.

Parameters:
paramname - name of the parameter to look for
Returns:
the error message or null if no error or parameter not found

checkDate

public E4Label_Intf checkDate(E4InputFieldName_Intf paramname,
                              boolean mandatory)
Checks, if a date parameter has any error.

Parameters:
paramname - name of the parameter to look for
mandatory - if true, an error is also returned if the value is empty
Returns:
the error message or null if no error or parameter not found
See Also:
checkDate(String), checkDate(e4s.html.input.extended.E4InputFieldName_Intf), checkDate(String,boolean)

checkParameterDate

public E4Label_Intf checkParameterDate(java.lang.String paramname)
Deprecated. 

See Also:
checkDate(e4s.html.input.extended.E4InputFieldName_Intf)

checkDate

public E4Label_Intf checkDate(java.lang.String paramname)
Checks, if a date parameter has any error.

Parameters:
paramname - name of the parameter to look for
Returns:
the error message or null if no error or parameter not found
See Also:
checkDate(e4s.html.input.extended.E4InputFieldName_Intf), checkDate(e4s.html.input.extended.E4InputFieldName_Intf,boolean), checkDate(String,boolean)

checkDate

public E4Label_Intf checkDate(java.lang.String paramname,
                              boolean mandatory)
Checks, if a date parameter has any error.

Parameters:
paramname - name of the parameter to look for
mandatory - if true, an error is also returned if the value is empty
Returns:
the error message or null if no error or parameter not found
See Also:
checkDate(String), checkDate(e4s.html.input.extended.E4InputFieldName_Intf), checkDate(e4s.html.input.extended.E4InputFieldName_Intf,boolean)

getParameterDate

public java.util.Date getParameterDate(java.lang.String paramname)
                                throws java.lang.Exception
Deprecated. 

Throws:
java.lang.Exception
See Also:
getDate(String)

getDate

public java.util.Date getDate(java.lang.String paramname)
                       throws java.lang.Exception
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or false if not available
Throws:
java.lang.Exception

getLanguage

public Language getLanguage(E4InputFieldName_Intf paramname,
                            Language defaultLanguage,
                            Language[] possibleLanguages)
Get a value as Language.

Parameters:
paramname - the parameter name
defaultLanguage - the default language, if parameter is not specified (may be null)
possibleLanguages - an array of possible languages, if null uses Language.getLanguages()
Returns:
the found parameter as language or the default language

getLanguage

public Language getLanguage(java.lang.String paramname,
                            Language defaultLanguage,
                            Language[] possibleLanguages)
Get a value as Language.

Parameters:
paramname - the parameter name
defaultLanguage - the default language, if parameter is not specified (may be null)
possibleLanguages - an array of possible languages, if null uses Language.getLanguages()
Returns:
the found parameter as language or the default language

getParameterDate

public java.util.Date getParameterDate(E4InputFieldName_Intf paramname)
                                throws java.lang.Exception
Deprecated. 

Throws:
java.lang.Exception
See Also:
getDate(e4s.html.input.extended.E4InputFieldName_Intf)

getDate

public java.util.Date getDate(E4InputFieldName_Intf paramname)
                       throws java.lang.Exception
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or false if not available
Throws:
java.lang.Exception

getDateC

public java.util.Calendar getDateC(E4InputFieldName_Intf paramname)
                            throws java.lang.Exception
Get the parameter from the parameter list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or false if not available
Throws:
java.lang.Exception

getDateNoException

public java.util.Date getDateNoException(E4InputFieldName_Intf paramname)
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or false if not available

checkParameterLong

public E4Label_Intf checkParameterLong(E4InputFieldName_Intf paramname)
Deprecated. 

See Also:
checkLong(e4s.html.input.extended.E4InputFieldName_Intf)

checkLong

public E4Label_Intf checkLong(E4InputFieldName_Intf paramname)
Checks, if a long parameter has any error.

Parameters:
paramname - name of the parameter to look for
Returns:
the error message or null if no error or parameter not found

checkParameterInt

public E4Label_Intf checkParameterInt(E4InputFieldName_Intf paramname)
Deprecated. 

See Also:
checkInt(e4s.html.input.extended.E4InputFieldName_Intf)

checkInt

public E4Label_Intf checkInt(E4InputFieldName_Intf paramname)
Checks, if a long parameter has any error.

Parameters:
paramname - name of the parameter to look for
Returns:
the error message or null if no error or parameter not found

checkParameterLong

public E4Label_Intf checkParameterLong(java.lang.String paramname)
Deprecated. 

See Also:
checkLong(String)

checkLong

public E4Label_Intf checkLong(java.lang.String paramname)
Checks, if a long parameter has any error.

Parameters:
paramname - name of the parameter to look for
Returns:
the error message or null if no error or parameter not found
See Also:
#checkLong(e4s.html.input.extendedn.E4InputFieldName_Intf)

checkFloat

public E4Label_Intf checkFloat(E4InputFieldName_Intf paramname)
Checks, if a long parameter has any error.

Parameters:
paramname - name of the parameter to look for
Returns:
the error message or null if no error or parameter not found
See Also:
#checkLong(e4s.html.input.extendedn.E4InputFieldName_Intf)

checkFloat

public E4Label_Intf checkFloat(E4InputFieldName_Intf paramname,
                               float min_value,
                               float max_value)
Checks, if a long parameter has any error.

Parameters:
paramname - name of the parameter to look for
min_value - the accepted minimum value for the float
max_value - the accepted maximum value for the float
Returns:
the error message or null if no error or parameter not found
See Also:
#checkLong(e4s.html.input.extendedn.E4InputFieldName_Intf)

checkFloat

public E4Label_Intf checkFloat(java.lang.String paramname)
Checks, if a long parameter has any error.

Parameters:
paramname - name of the parameter to look for
Returns:
the error message or null if no error or parameter not found
See Also:
checkLong(e4s.html.input.extended.E4InputFieldName_Intf)

checkFloat

public E4Label_Intf checkFloat(java.lang.String paramname,
                               float min_value,
                               float max_value)
Checks, if a long parameter has any error.

Parameters:
paramname - name of the parameter to look for
min_value - the accepted minimum value for the float
max_value - the accepted maximum value for the float
Returns:
the error message or null if no error or parameter not found
See Also:
checkLong(e4s.html.input.extended.E4InputFieldName_Intf)

checkParameterBool

public E4Label_Intf checkParameterBool(java.lang.String paramname)
Deprecated. 

See Also:
checkBool(String)

checkBool

public E4Label_Intf checkBool(java.lang.String paramname)
Checks, if a boolean parameter has any error.

Parameters:
paramname - name of the parameter to look for
Returns:
the error message or null if no error or parameter not found

checkParameterBool

public E4Label_Intf checkParameterBool(E4InputFieldName_Intf paramname)
Deprecated. 

See Also:
checkBool(e4s.html.input.extended.E4InputFieldName_Intf)

checkBool

public E4Label_Intf checkBool(E4InputFieldName_Intf paramname)
Checks, if a boolean parameter has any error.

Parameters:
paramname - name of the parameter to look for
Returns:
the error message or null if no error or parameter not found

checkParameterInt

public E4Label_Intf checkParameterInt(java.lang.String paramname)
Deprecated. 

See Also:
checkInt(String)

checkInt

public E4Label_Intf checkInt(java.lang.String paramname)
Checks, if a long parameter has any error.

Parameters:
paramname - name of the parameter to look for
Returns:
the error message or null if no error or parameter not found

getParameterLong

public long getParameterLong(java.lang.String paramname)
Deprecated. 

See Also:
getLong(String)

getLong

public long getLong(java.lang.String paramname)
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or -1 if not available

getParameterLong

public long getParameterLong(E4InputFieldName_Intf paramname)
Deprecated. 

See Also:
getLong(e4s.html.input.extended.E4InputFieldName_Intf)

getLong

public long getLong(E4InputFieldName_Intf paramname)
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or -1 if not available

getParameterFloat

public float getParameterFloat(java.lang.String paramname)
Deprecated. 

See Also:
getFloat(String)

getParameterFloat

public float getParameterFloat(E4InputFieldName_Intf paramname)
Deprecated. 

See Also:
getFloat(e4s.html.input.extended.E4InputFieldName_Intf)

getFloat

public float getFloat(java.lang.String paramname)
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or 0.0 if not available
See Also:
getFloat(String,e4s.db.systabledef.E4DecimalSign), getFloat(String,char)

getFloat

public float getFloat(E4InputFieldName_Intf paramname)
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or 0.0 if not available
See Also:
getFloat(String,e4s.db.systabledef.E4DecimalSign), getFloat(String,char)

getParameterFloat

public float getParameterFloat(java.lang.String paramname,
                               E4DecimalSign decimal)
Deprecated. 

See Also:
getFloat(E4InputFieldName_Intf, E4DecimalSign)

getFloat

public float getFloat(java.lang.String paramname,
                      E4DecimalSign decimal)
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or 0.0 if not available

getParameterFloat

public float getParameterFloat(E4InputFieldName_Intf paramname,
                               E4DecimalSign decimal)
Deprecated. 

See Also:
getFloat(E4InputFieldName_Intf, E4DecimalSign)

getFloat

public float getFloat(E4InputFieldName_Intf paramname,
                      E4DecimalSign decimal)
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or 0.0 if not available

getParameterFloat

public float getParameterFloat(java.lang.String paramname,
                               char decimalsign)
Deprecated. 

See Also:
getFloat(String,char)

getFloat

public float getFloat(java.lang.String paramname,
                      char decimalsign)
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or 0.0 if not available
See Also:
getFloat(String,e4s.db.systabledef.E4DecimalSign)

getInt

public int getInt(java.lang.String paramname)
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or -1 if not available

getParameterInt

public int getParameterInt(java.lang.String paramname)
Deprecated. 

See Also:
getInt(String)

getParameterInt

public int getParameterInt(E4InputFieldName_Intf paramname)
Deprecated. 

See Also:
getInt(e4s.html.input.extended.E4InputFieldName_Intf)

getInt

public int getInt(E4InputFieldName_Intf paramname)
Get the parameter from the list.

Parameters:
paramname - name of the parameter to look for
Returns:
the value for paramname or -1 if not available

getParameterArray

public java.lang.String[] getParameterArray(java.lang.String baseparamname)
Deprecated. 

See Also:
getArray(String)

getArray

public java.lang.String[] getArray(java.lang.String baseparamname)
Get the parameter from the list.

Parameters:
baseparamname - name of the parameter to look for
Returns:
the value for paramname or -1 if not available

getArrayLong

public long[] getArrayLong(java.lang.String baseparamname)
Get the parameter from the list.

Parameters:
baseparamname - name of the parameter to look for
Returns:
the values for paramname or null if not available
See Also:
add(String,long[])

getArrayBool

public boolean[] getArrayBool(java.lang.String baseparamname)
Get the parameter from the list.

Parameters:
baseparamname - name of the parameter to look for
Returns:
the values for paramname or null if not available
See Also:
add(String,boolean[])

getParameter

public void getParameter(java.lang.Object obj,
                         java.lang.String alias)
Deprecated. 

See Also:
get(Object,String)

get

public void get(java.lang.Object obj,
                java.lang.String alias)
Gets a parameter for each member variable of obj beginning with "m_". Note, that each paramater must begin with an (case-sensitive) "m_" and be declared public. Each parameter is stored as [alias].[fieldname]. Implementation for String, int, long and boolean members only!!

Parameters:
obj - the object
alias - an alias name for the object

removeAll

public void removeAll()
Clears all parameters


removeParameter

public void removeParameter(java.lang.String name)
Deprecated. 

See Also:
remove(String)

remove

public void remove(java.lang.String name)
Remove the specified parameter.

Parameters:
name - the parameter to be removed

removeParameter

public void removeParameter(E4InputFieldName_Intf name)
Deprecated. 

See Also:
remove(e4s.html.input.extended.E4InputFieldName_Intf)

remove

public void remove(E4InputFieldName_Intf name)
Remove the specified parameter.

Parameters:
name - the parameter to be removed

getParameters

public java.util.Enumeration getParameters()
Get the parameter list.

Returns:
an String based Enumeration representing all the stored parameters
See Also:
#getName()

toString

public java.lang.String toString()
Build a list with >CR<>LF%lt; at the end of each line. Each line contains one entry in the form paramname = value.

Overrides:
toString in class E4Object
Returns:
list of all parameters

toString

public java.lang.String toString(java.lang.String delimiter)
Build a string with all parameters.

Parameters:
delimiter - delimiter between each parameter
Returns:
list of all parameters

toCgiCall

public java.lang.String toCgiCall()
Concatenate the parameters in the Cgi style.

Returns:
&P1=V1&P2=V2..

toTable

public void toTable(TABLE table)

getNames

public java.lang.String[] getNames()
Get the parameter names as array.

Returns:
null if empty
See Also:
getParameters()

toTable

public void toTable(TABLE table,
                    java.lang.String header)

getFormatPicture

public static java.lang.String getFormatPicture(java.lang.String paramname)
Extract the dateformat from a paramname. Can only be used on DATEFIELDS, make sure before calling that paramname contains NAME_SEPERATOR otherwise this will cause an Error thrown.

Parameters:
paramname - a parameter for a CGI input field containing the date picture. e.g. "BIRTHDATE$7" (assuming that NAME_SEPERATOR is def ined as $)
Returns:
a date picture, used by SimpleDateFormat, e.g. "yyyyMMdd"
See Also:
DATEFIELD.getFormatAlias(String), DATEFIELD.getFormatPicture(int), NAME_SEPERATOR

size

public int size()
Get the size (number of elements) in the parameters object.

Returns:
0 if no parameter is defined or the size of parameters

addTimestamp

public void addTimestamp()
Adds a timestamp parameter to guarantee unique new parameters and avoid caching of browsers or proxies.

See Also:
E4Constants.PARAM_TIMESTAMP

clone

public java.lang.Object clone()
Clone the parameters.

Overrides:
clone in class java.lang.Object
Returns:
a copy of the params

copy

public E4CgiParams copy()
Same as clone()

Returns:
a copy of the params

toHIDDENFIELD

public void toHIDDENFIELD(FORM form)
                   throws java.lang.Exception
Same implementation as FORM.toHIDDENFIELD(e4s.html.E4CgiParams)

Parameters:
form - the form where the fields shall be added
Throws:
java.lang.Exception
See Also:
toHIDDENFIELD(e4s.html.FORM, e4s.html.input.extended.E4InputFieldName_Intf[])

toHIDDENFIELD

public void toHIDDENFIELD(FORM form,
                          E4InputFieldName_Intf[] except)
                   throws java.lang.Exception
Same implementation as FORM.toHIDDENFIELD(e4s.html.E4CgiParams, e4s.html.input.extended.E4InputFieldName_Intf[])

Parameters:
form - the form where the fields shall be added
except - an array of field to be ignored
Throws:
java.lang.Exception
See Also:
toHIDDENFIELD(e4s.html.FORM)

_getSVNVersionString

public static java.lang.String _getSVNVersionString()

www.element4solution.com