| org.hibernate.Filter
All known Subclasses: org.hibernate.impl.FilterImpl,
Filter | public interface Filter (Code) | | Type definition of Filter. Filter defines the user's view into enabled dynamic filters,
allowing them to set filter parameter values.
author: Steve Ebersole |
getFilterDefinition | public FilterDefinition getFilterDefinition()(Code) | | Get the filter definition containing additional information about the
filter (such as default-condition and expected parameter names/types).
The filter definition |
getName | public String getName()(Code) | | Get the name of this filter.
This filter's name. |
setParameter | public Filter setParameter(String name, Object value)(Code) | | Set the named parameter's value for this filter.
Parameters: name - The parameter's name. Parameters: value - The value to be applied. This FilterImpl instance (for method chaining). |
setParameterList | public Filter setParameterList(String name, Collection values)(Code) | | Set the named parameter's value list for this filter. Used
in conjunction with IN-style filter criteria.
Parameters: name - The parameter's name. Parameters: values - The values to be expanded into an SQL IN list. This FilterImpl instance (for method chaining). |
setParameterList | public Filter setParameterList(String name, Object[] values)(Code) | | Set the named parameter's value list for this filter. Used
in conjunction with IN-style filter criteria.
Parameters: name - The parameter's name. Parameters: values - The values to be expanded into an SQL IN list. This FilterImpl instance (for method chaining). |
validate | public void validate() throws HibernateException(Code) | | Perform validation of the filter state. This is used to verify the
state of the filter after its enablement and before its use.
throws: HibernateException - If the state is not currently valid. |
|
|