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

getCriteria

public Object getCriteria()
Retrieves filtering object.

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

setCriteria

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



Copyright 1999-2009 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.