FileDocCategorySizeDatePackage
Filter.javaAPI DocHibernate 3.2.51969Mon Dec 05 16:37:00 GMT 2005org.hibernate

Filter

public interface Filter
Type definition of Filter. Filter defines the user's view into enabled dynamic filters, allowing them to set filter parameter values.
author
Steve Ebersole

Fields Summary
Constructors Summary
Methods Summary
public org.hibernate.engine.FilterDefinitiongetFilterDefinition()
Get the filter definition containing additional information about the filter (such as default-condition and expected parameter names/types).

return
The filter definition

public java.lang.StringgetName()
Get the name of this filter.

return
This filter's name.

public org.hibernate.FiltersetParameter(java.lang.String name, java.lang.Object value)
Set the named parameter's value for this filter.

param
name The parameter's name.
param
value The value to be applied.
return
This FilterImpl instance (for method chaining).

public org.hibernate.FiltersetParameterList(java.lang.String name, java.util.Collection values)
Set the named parameter's value list for this filter. Used in conjunction with IN-style filter criteria.

param
name The parameter's name.
param
values The values to be expanded into an SQL IN list.
return
This FilterImpl instance (for method chaining).

public org.hibernate.FiltersetParameterList(java.lang.String name, java.lang.Object[] values)
Set the named parameter's value list for this filter. Used in conjunction with IN-style filter criteria.

param
name The parameter's name.
param
values The values to be expanded into an SQL IN list.
return
This FilterImpl instance (for method chaining).

public voidvalidate()
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.