com.redhat.rhn.frontend.taglibs.list

Interface ListFilter

All Known Implementing Classes:

BaseConfigFilter, BaseListFilter, ColumnFilter, ConfigChannelFilter, ConfigFileFilter, ConfigSystemFilter, CustomKeyOverviewFilter, ErrataFilter, KickstartIpRangeFilter, KickstartProfileFilter, OrgListFilter, PackageFilter, PackageNameFilter, PackageNameFilter, PackageNVREAFilter, SnapshotTagFilter, SystemCurrencyFilter, SystemGroupFilter, SystemNoteFilter, SystemOverviewFilter, TrustListFilter, UserListFilter, ViewModifyPathsFilter, VirtualSystemOverviewFilter

public interface ListFilter

Defines the interface for filtering data in the ListTag

Method Summary

Modifier and Type	Method and Description
boolean	filter(java.lang.Object object, java.lang.String field, java.lang.String criteria) Invoked on each object in the complete list of data beans
java.util.List	getFieldNames() Returns the list of data bean field names the filter can filter on It is the responsibility of the class implementing this interface to provide any localization
void	postFilter(java.util.List filteredList) Invoked after the list of filtered objects has been built and before the list is returned from ListFilterHelper.
void	prepare(java.util.Locale userLocale) Called before any other methods are called

Method Detail

prepare

void prepare(java.util.Locale userLocale)

Called before any other methods are called

Parameters:

userLocale - locale of the requesting user

getFieldNames

java.util.List getFieldNames()

Returns the list of data bean field names the filter can filter on It is the responsibility of the class implementing this interface to provide any localization

Returns:

List of field names

filter

boolean filter(java.lang.Object object,
               java.lang.String field,
               java.lang.String criteria)

Invoked on each object in the complete list of data beans

Parameters:

object - Individual data beans

field - field name to inspect

criteria - filter criteria

Returns:

true if the data bean passes, false if not

postFilter

void postFilter(java.util.List filteredList)

Invoked after the list of filtered objects has been built and before the list is returned from ListFilterHelper.

Parameters:

filteredList - The filtered list