Summary: Methods | [Expand All]
public interface

Filter

org.hibernate.Filter
Known Indirect Subclasses

Class Overview

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

Summary

Public Methods
abstract FilterDefinition getFilterDefinition()
Get the filter definition containing additional information about the filter (such as default-condition and expected parameter names/types).
abstract String getName()
Get the name of this filter.
abstract Filter setParameter(String name, Object value)
Set the named parameter's value for this filter.
abstract Filter setParameterList(String name, Collection values)
Set the named parameter's value list for this filter.
abstract Filter setParameterList(String name, Object[] values)
Set the named parameter's value list for this filter.
abstract void validate()
Perform validation of the filter state.

Public Methods

public abstract FilterDefinition getFilterDefinition ()

Get the filter definition containing additional information about the filter (such as default-condition and expected parameter names/types).

Returns
  • The filter definition

public abstract String getName ()

Get the name of this filter.

Returns
  • This filter's name.

public abstract Filter setParameter (String name, Object value)

Set the named parameter's value for this filter.

Parameters
name The parameter's name.
value The value to be applied.
Returns
  • This FilterImpl instance (for method chaining).

public abstract Filter setParameterList (String name, Collection values)

Set the named parameter's value list for this filter. Used in conjunction with IN-style filter criteria.

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

public abstract Filter setParameterList (String name, Object[] values)

Set the named parameter's value list for this filter. Used in conjunction with IN-style filter criteria.

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

public abstract void validate ()

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.