|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface Filter
Type definition of Filter. Filter defines the user's view into enabled dynamic filters, allowing them to set filter parameter values.
| Method Summary | |
|---|---|
FilterDefinition |
getFilterDefinition()
Get the filter definition containing additional information about the filter (such as default-condition and expected parameter names/types). |
String |
getName()
Get the name of this filter. |
Filter |
setParameter(String name,
Object value)
Set the named parameter's value for this filter. |
Filter |
setParameterList(String name,
Collection values)
Set the named parameter's value list for this filter. |
Filter |
setParameterList(String name,
Object[] values)
Set the named parameter's value list for this filter. |
void |
validate()
Perform validation of the filter state. |
| Method Detail |
|---|
String getName()
FilterDefinition getFilterDefinition()
Filter setParameter(String name,
Object value)
name - The parameter's name.value - The value to be applied.
Filter setParameterList(String name,
Collection values)
name - The parameter's name.values - The values to be expanded into an SQL IN list.
Filter setParameterList(String name,
Object[] values)
name - The parameter's name.values - The values to be expanded into an SQL IN list.
void validate()
throws HibernateException
HibernateException - If the state is not currently valid.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||