com.ibm.commerce.tools.common.ui
Interface SimpleDynamicListBean

All Known Implementing Classes:
DiscountCalculationCodeListBean, DiscountChooseListBean

public interface SimpleDynamicListBean

Creates a Dynamic List through a databean.


Method Summary
 java.lang.String getCheckBoxName(int i)
          Returns the name of the check box in each row.
 java.lang.String[] getColumns(int i)
          Returns the content of row i
 java.lang.String getDefaultAction(int i)
          This method returns the first column hyper-link.
 java.lang.String[][] getHeadings()
          This method returns the headings of the table.
 int getListSize()
          This method returns the size of your result.
 java.lang.String getParm(java.lang.String para)
          This method returns the given parameter's value.
 java.lang.String getUserJSfnc(java.util.Hashtable NLSfile)
          Returns the user defined JavaScript function.
 void setParm(java.lang.String para, java.lang.String value)
          This method sets the given parameter para equal to value value.
 

Method Detail

getCheckBoxName

public java.lang.String getCheckBoxName(int i)
Returns the name of the check box in each row. The name should be unique. Normally, this is the parameter you want to pass on to the other views.
Parameters:
i - The for which you want the name of the check box.
Returns:
The name of the check box for the specified row.

getColumns

public java.lang.String[] getColumns(int i)
Returns the content of row i
Parameters:
i - The row for which you want to return the contents.
Returns:
The contents of the row of the DynamicList.

getDefaultAction

public java.lang.String getDefaultAction(int i)
This method returns the first column hyper-link.
Parameters:
i - The row for which you want the first column hyper-link.
Returns:
The hyper-link for the specified row.

getHeadings

public java.lang.String[][] getHeadings()
This method returns the headings of the table.

The first column is the NLS entry name used to locate the NLS character in your property file. The second is the variable name of this column which is used for sorting purposes.

If you do not want this column to be sorted, put "null" for the variable name of this column.

Returns:
The headings of the table.

getListSize

public int getListSize()
This method returns the size of your result.
Returns:
the size of your result.

getParm

public java.lang.String getParm(java.lang.String para)
This method returns the given parameter's value.
Parameters:
The - name of the parameter for which you wish to retrieve the value.
Returns:
The value of the specified parameter.

getUserJSfnc

public java.lang.String getUserJSfnc(java.util.Hashtable NLSfile)
Returns the user defined JavaScript function. This method is provided for easily processing NLS characters and Java objects used in the user's JavaScript functions. If your file does not have any NLS or java related issues, you can use the tag in your XML file to include the JavaScript file.
Parameters:
NLSfile - The JavaScript file which contains NL characters.
Returns:
The JavaScript file with NL characters.

setParm

public void setParm(java.lang.String para,
                    java.lang.String value)
This method sets the given parameter para equal to value value.
Parameters:
para - The parameter to recieve the value.
value - The value to be set.