com.sencha.gxt.data.shared.loader
Interface FilterConfig

All Superinterfaces:

BaseProxy, ValueProxy

All Known Implementing Classes:

FilterConfigBean

public interface FilterConfig
extends ValueProxy

A filter configuration interface. Encapsulates state information needed for filtering, including field name, type, value and comparison.

Method Summary

java.lang.String	getComparison() Returns the type of filter comparison.
java.lang.String	getField() Returns the name of the filter field.
java.lang.String	getType() Returns the filter type.
java.lang.String	getValue() Gets the filter value.
void	setComparison(java.lang.String comparison) Sets the type of filter comparison (e.g.
void	setField(java.lang.String field) Sets the name of the filter field.
void	setType(java.lang.String type) Sets the filter type (e.g.
void	setValue(java.lang.String value) Sets the filter value.

Method Detail

getComparison

java.lang.String getComparison()

Returns the type of filter comparison.

Returns:

the type of filter comparison

getField

java.lang.String getField()

Returns the name of the filter field.

Returns:

the name of the filter field.

getType

java.lang.String getType()

Returns the filter type.

Returns:

the filter type

getValue

java.lang.String getValue()

Gets the filter value. To convert from String to native representation, see FilterHandler.convertToObject(String).

Returns:

the string representation of the value

setComparison

void setComparison(java.lang.String comparison)

Sets the type of filter comparison (e.g. "after", "before", "on").

Parameters:

comparison - the type of filter comparison

setField

void setField(java.lang.String field)

Sets the name of the filter field.

Parameters:

field - the name of the filter field

setType

void setType(java.lang.String type)

Sets the filter type (e.g. "boolean", "date", "list", "numeric", "string").

Parameters:

type - the type name

setValue

void setValue(java.lang.String value)

Sets the filter value. To convert from native to String representation, see FilterHandler.convertToString(Object).

Parameters:

value - the string representation of the value