public interface Filter
Type definition of Filter. Filter defines the user’s view into enabled dynamic filters, allowing them to set filter parameter values.
Modifier and Type | Method and Description |
---|---|
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.
|
String getName()
Get the name of this filter.
FilterDefinition getFilterDefinition()
Get the filter definition containing additional information about the filter (such as default-condition and expected parameter names/types).
Filter setParameter(String name, Object value)
Set the named parameter’s value for this filter.
name
- The parameter’s name.value
- The value to be applied.Filter setParameterList(String name, Collection values)
Set the named parameter’s value list for this filter. Used in conjunction with IN-style filter criteria.
name
- The parameter’s name.values
- The values to be expanded into an SQL IN list.Filter setParameterList(String name, Object[] values)
Set the named parameter’s value list for this filter. Used in conjunction with IN-style filter criteria.
name
- The parameter’s name.values
- The values to be expanded into an SQL IN list.void validate() throws HibernateException
Perform validation of the filter state. This is used to verify the state of the filter after its enablement and before its use.
HibernateException
- If the state is not currently valid.Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.