com.ibm.commerce.tools.common.ui

Interface SimpleDynamicListBean

All Known Implementing Classes:

ECouponPromotionListBean, RLDiscountListBaseBean, RLDiscountListBean, RLProdPromoListBean, RLPromotionListBean

public interface SimpleDynamicListBean

Creates a Dynamic List through a data bean.

Method Summary

Modifier and Type	Method and Description
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 hyperlink.
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

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 row for which you want to return the check box name.

Returns:

The name of the check box for the specified row.

getColumns

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

java.lang.String getDefaultAction(int i)

This method returns the first column hyperlink.

Parameters:

i - The row for which you want the first column hyperlink.

Returns:

The hyperlink for the specified row.

getHeadings

java.lang.String[][] getHeadings()

This method returns the headings of the table.

The first column is the national language entry name used to locate the national language 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

int getListSize()

This method returns the size of your result.

Returns:

The size of your result.

getParm

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

java.lang.String getUserJSfnc(java.util.Hashtable NLSfile)

Returns the user defined JavaScript function. This method is provided for easily processing national language characters and Java objects used in the user's JavaScript functions. If your file does not have any national language messages or Java related issues, you can use the jsFile tag in your XML file to include the JavaScript file.

Parameters:

NLSfile - The JavaScript file which contains national language characters.

Returns:

The JavaScript file with national language characters.

setParm

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 receive the value.

value - The value to be set.