Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.hibernate
Interface Filter  view Filter download Filter.java


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
 org.hibernate.engine.FilterDefinition getFilterDefinition()
          Get the filter definition containing additional information about the filter (such as default-condition and expected parameter names/types).
 java.lang.String getName()
          Get the name of this filter.
 Filter setParameter(java.lang.String name, java.lang.Object value)
          Set the named parameter's value for this filter.
 Filter setParameterList(java.lang.String name, java.util.Collection values)
          Set the named parameter's value list for this filter.
 Filter setParameterList(java.lang.String name, java.lang.Object[] values)
          Set the named parameter's value list for this filter.
 void validate()
          Perform validation of the filter state.
 

Method Detail

getName

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


getFilterDefinition

public org.hibernate.engine.FilterDefinition getFilterDefinition()
Get the filter definition containing additional information about the filter (such as default-condition and expected parameter names/types).


setParameter

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


setParameterList

public Filter setParameterList(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.


setParameterList

public Filter setParameterList(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.


validate

public 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.