com.ds.fw.dv.params
Class FwDVParams

java.lang.Object
  |
  +--com.ds.fw.types.FwSimpleObject
        |
        +--com.ds.fw.dv.params.FwDVParams

All Implemented Interfaces:

java.lang.Cloneable, FwCopyableIF, FwDisplayableIF, FwSimpleObjectIF, java.io.Serializable

public class FwDVParams

extends FwSimpleObject

This class represents the edit table options parameters. All parameters are grouped in hashtables by their meanning. These internal tables are:
0 - contains the params addressed to the edit table, which it has to proccess;
1 - contains the params addressed from the edit table. Here the default value "id" for example is send from the list to the view when you select an item from the list to be displayed in the view.
2 - contains optional parameters for future usage;
3 - empty for now, it is for future usage.

See Also:

Serialized Form

Constructor Summary

FwDVParams()
Constructor.

Method Summary

com.ds.fw.dv.params.FwDVValue	get(int i, java.lang.String key) This method returns the parameter's data for a parameter from table i with name key.
com.ds.fw.dv.params.FwDVValue	get(java.lang.String key) This method returns the parameter's data for a parameter from default(0) table with name key.
java.lang.Object	get1(int i, java.lang.String key) This method returns the value of the parameter key from table i.
java.util.Hashtable	getHData(int i) This methods returns a handle to one of the internal hashtables.
java.lang.String	param() This method returns a String with URL parameters.
java.lang.String	param(int i) This method returns a String with URL parameters.
java.lang.String	param(int i, java.lang.String sKey, java.lang.Object oValue) This method returns a String with URL parameters.
java.lang.String	param(int i, java.lang.String sKey, java.lang.Object oValue, java.lang.String sKey1, java.lang.Object oValue1) This method returns a String with URL parameters.
java.lang.String	param(int im, java.lang.String sKey, java.lang.Object oValue, java.lang.String sKey1, java.lang.Object oValue1, java.lang.String sKey2, java.lang.Object oValue2) This method returns a String with URL parameters.
java.lang.String	param1(int i) This method returns a String with HTML code, which represents the parameters of an internal table as hidden fields in a HTML form.
java.lang.String	param1(int im, java.lang.String sKey, java.lang.Object oValue, java.lang.String sKey1, java.lang.Object oValue1, java.lang.String sKey2, java.lang.Object oValue2) This method returns a String with HTML code, which represents the parameters of an internal table as hidden fields in a HTML form.
void	set(int i, java.lang.String key, com.ds.fw.dv.params.FwDVValue data) This method sets parameter's data for a parameter from table i with name key.
void	set(java.lang.String key, com.ds.fw.dv.params.FwDVValue data) This method sets parameter's data for a parameter from default(0)table with name key.
void	set1(int i, java.lang.String key, java.lang.Object data) This method sets the value of the parameter key from table i.

Methods inherited from class com.ds.fw.types.FwSimpleObject

getClassName, getClone, getCopy, getCopy, getDeepCopy, getDisplayString, getDisplayStringFor, postCopy, printStackTrace, toString, toStringValue

Methods inherited from class java.lang.Object

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

Constructor Detail

FwDVParams

public FwDVParams()

Constructor. Initializes the hashtables with default values.

Method Detail

getHData

public java.util.Hashtable getHData(int i)

This methods returns a handle to one of the internal hashtables.

Parameters:

i - the zero-based index of the table to be returned

get

public com.ds.fw.dv.params.FwDVValue get(java.lang.String key)

This method returns the parameter's data for a parameter from default(0) table with name key.

Parameters:

key - the parameter name

Returns:

a FwDVValue object with the parameter value

See Also:

get(int,String)

get

public com.ds.fw.dv.params.FwDVValue get(int i,
                                         java.lang.String key)

This method returns the parameter's data for a parameter from table i with name key.

Parameters:

i - index of the table with parameters

key - the parameter name

Returns:

a FwDVValue object with the parameter value

set

public void set(java.lang.String key,
                com.ds.fw.dv.params.FwDVValue data)

This method sets parameter's data for a parameter from default(0)table with name key.

Parameters:

key - the parameter name

data - data to be set

set

public void set(int i,
                java.lang.String key,
                com.ds.fw.dv.params.FwDVValue data)

This method sets parameter's data for a parameter from table i with name key.

Parameters:

i - index of the table with parameters

key - the parameter name

data - data to be set

get1

public java.lang.Object get1(int i,
                             java.lang.String key)

This method returns the value of the parameter key from table i.

Parameters:

i - index of the table with parameters

key - the parameter name

Returns:

the value of the parameter

set1

public void set1(int i,
                 java.lang.String key,
                 java.lang.Object data)

This method sets the value of the parameter key from table i. If this parameter is not available it is created.

Parameters:

i - index of the table with parameters

key - the parameter name

data - value to be set

param1

public java.lang.String param1(int i)

This method returns a String with HTML code, which represents the parameters of an internal table as hidden fields in a HTML form. This way they will be send when the form is submitted. The parameters are get from the internal table with index i. If a parameter has to have its default value it is not included in the URL.

Parameters:

i - index of the table with parameters

See Also:

param1(int,String,Object,String,Object,String,Object)

param

public java.lang.String param()

This method returns a String with URL parameters. This string is build from the default(0) internal table. If a parameter has to have its default value it is not included in the URL.

See Also:

param(int,String,Object,String,Object,String,Object)

param

public java.lang.String param(int i)

This method returns a String with URL parameters. This string is build from the internal table with index i. If a parameter has to have its default value it is not included in the URL.

Parameters:

i - index of the table with parameters

See Also:

param(int,String,Object,String,Object,String,Object)

param

public java.lang.String param(int i,
                              java.lang.String sKey,
                              java.lang.Object oValue)

This method returns a String with URL parameters. This string is build from the internal table with index i. If a parameter with name sKey is found then its value is replaced with oValue. If a parameter has to have its default value it is not included in the URL.

Parameters:

i - index of the table with parameters

sKey - first parameter to be replaced

oValue -

See Also:

param(int,String,Object,String,Object,String,Object)

param

public java.lang.String param(int i,
                              java.lang.String sKey,
                              java.lang.Object oValue,
                              java.lang.String sKey1,
                              java.lang.Object oValue1)

This method returns a String with URL parameters. This string is build from the internal table with index im. If a parameter with name sKey or sKey1 is found then its value is replaced with oValue or oValue1 respectively. If a parameter has to have its default value it is not included in the URL.

Parameters:

i - index of the table with parameters

sKey - first parameter to be replaced

oValue - value to be set to parameter sKey

sKey1 - second parameter to be replaced

oValue1 -

See Also:

param(int,String,Object,String,Object,String,Object)

param

public java.lang.String param(int im,
                              java.lang.String sKey,
                              java.lang.Object oValue,
                              java.lang.String sKey1,
                              java.lang.Object oValue1,
                              java.lang.String sKey2,
                              java.lang.Object oValue2)

This method returns a String with URL parameters. This string is build from the internal table with index im. If a parameter with name sKey, sKey1 or sKey3 is found then its value is replaced with oValue,oValue1 or oValue2 respectively. If a parameter has to have its default value it is not included in the URL.

Parameters:

im - index of the table with parameters

sKey - first parameter to be replaced

oValue - value to be set to parameter sKey

sKey1 - second parameter to be replaced

oValue1 - value to be set to parameter sKey1

sKey2 - third parameter to be replaced

oValue2 - value to be set to parameter sKey2

param1

public java.lang.String param1(int im,
                               java.lang.String sKey,
                               java.lang.Object oValue,
                               java.lang.String sKey1,
                               java.lang.Object oValue1,
                               java.lang.String sKey2,
                               java.lang.Object oValue2)

This method returns a String with HTML code, which represents the parameters of an internal table as hidden fields in a HTML form. This way they will be send when the form is submitted. The parameters are get from the internal table with index im. If a parameter with name sKey, sKey1 or sKey3 is found then its value is replaced with oValue,oValue1 or oValue2 respectively. If a parameter has to have its default value it is not included in the URL.

Parameters:

im - index of the table with parameters

sKey - first parameter to be replaced

oValue - value to be set to parameter sKey

sKey1 - second parameter to be replaced

oValue1 - value to be set to parameter sKey1

sKey2 - third parameter to be replaced

oValue2 - value to be set to parameter sKey2