com.bea.wlw.netui.databinding.jsp
Class FilterWindowService.FilterWindowData

java.lang.Object
  com.bea.wlw.netui.databinding.jsp.FilterWindowService.FilterWindowData

Enclosing class:

FilterWindowService

public static final class FilterWindowService.FilterWindowData
extends Object

The FilterWindowData class contains information extracted from the current request and response which is used when rendering a filter window. The information contained here is tightly coupled with all of the infrastructure used to render the filter window and submit new / changed filters to the server.

Method Summary

String	getClearAllFiltersQueryString() Get a query parameters string that can reset all of the filters for all columns on the current grid.
String	getClearColumnFiltersQueryString() Get a query parameters string that can reset all of the filters for the current column / grid pair.
String	getColumnName() Get the name of the column to filter
int	getDefaultFilterOperation() Given the type of the column, get the default filter operation for the column
String	getFilterAction() Get a Page Flow action which the filter window executes if a change is made to the current filter set.
String	getFilterKey() Get the key used to set a filter on the URL.
FilterWindowService.Filter[]	getFilters() Get an array of the filters currently applied to a grid for the current column
String	getGridName() Get the name of the current grid on which a filter may be applied
int	getJDBCColumnType() Get the JDBC type of the current column.
String[][]	getOptions() Get a list of options that are available for display in the filter drop downs of the filter window.
String	getPrefix() Get any prefix that should be applied to parameters that are set on the URL from the filter window.
String	toString() Create a String containing the state of a FilterWindowData object.

Methods inherited from class java.lang.Object

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

Method Detail

getPrefix

public String getPrefix()

Get any prefix that should be applied to parameters that are set on the URL from the filter window.

Returns:

the String prefix

getFilterKey

public String getFilterKey()

Get the key used to set a filter on the URL.

Returns:

the String filter key

getColumnName

public String getColumnName()

Get the name of the column to filter

Returns:

the String column name to filter

getClearAllFiltersQueryString

public String getClearAllFiltersQueryString()

Get a query parameters string that can reset all of the filters for all columns on the current grid.

Returns:

the query parameters String that can be used to reset all of the filters on the current grid.

getClearColumnFiltersQueryString

public String getClearColumnFiltersQueryString()

Get a query parameters string that can reset all of the filters for the current column / grid pair.

Returns:

the query parameters String that can be used to reset all of the filters on current column / grid pair.

getFilterAction

public String getFilterAction()

Get a Page Flow action which the filter window executes if a change is made to the current filter set.

Returns:

a String action name

getGridName

public String getGridName()

Get the name of the current grid on which a filter may be applied

Returns:

the name of a grid

getFilters

public FilterWindowService.Filter[] getFilters()

Get an array of the filters currently applied to a grid for the current column

Returns:

a #Filter array

getJDBCColumnType

public int getJDBCColumnType()

Get the JDBC type of the current column. These values are taken from the Types class.

Returns:

an int representing the type of a column

getDefaultFilterOperation

public int getDefaultFilterOperation()

Given the type of the column, get the default filter operation for the column

Returns:

the default filter operation for the currnet column

getOptions

public String[][] getOptions()

Get a list of options that are available for display in the filter drop downs of the filter window. Not all operations are available for all column types. The return value is a two dimensional array of Strings as:

   (readable name of an operation, URL key of an operation)
 

Returns:

the list of filter opations.

toString

public String toString()

Create a String containing the state of a FilterWindowData object.

Overrides:

toString in class Object

Returns:

a String

Exclude: