net.rim.device.api.collection
Interface FilterCollection

public interface FilterCollection

Criteria for filtering elements out of a collection.

This class lets you set and get a filtering object which an existing collection (or chainable collection) can use to selectively remove elements.

The filtering object should contain a set of filtering criteria which the collection object will understand and act upon accordingly.

Method Summary
Object	getCriteria() Retrieves filtering object.
void	setCriteria(Object criteria, FilterStatusListener listener) Sets filtering object.

Method Detail

setCriteria

void setCriteria(Object criteria,
                 FilterStatusListener listener)

Sets filtering object.

Parameters:

criteria - Object containing the filtering criteria.

listener - Listener object to notify when the filtering begins and ends.

getCriteria

Object getCriteria()

Retrieves filtering object.

Returns:

Object containing current filtering criteria, or null if no filtering object has yet been set.