net.rim.device.api.collection.util
Interface FilteredList

All Superinterfaces:
Collection, CollectionEventSource, ReadableList
All Known Implementing Classes:
BasicFilteredList

public interface FilteredList
extends ReadableList, CollectionEventSource

A generic interface for finding matching data objects.

Implementations that read this list must synchronize on the lock obtained by getLock() for thread-safe execution.

One implementation is the BasicFilteredList.

Since:
BlackBerry API 5.0.0

Method Summary
 Object getCriteria()
          Gets the search criteria object.
 Object getLock()
          All synchronized operations should use this lock.
 void reset()
          Start a new search with the current criteria.
 void setCriteria(Object criteria, FilterStatusListener listener)
          Sets the search criteria and starts a search.
 void waitForComplete()
          Wait until filtering is complete.
 
Methods inherited from interface net.rim.device.api.collection.ReadableList
getAt, getAt, getIndex, size
 
Methods inherited from interface net.rim.device.api.collection.CollectionEventSource
addCollectionListener, removeCollectionListener
 



Method Detail

setCriteria

void setCriteria(Object criteria,
                 FilterStatusListener listener)
Sets the search criteria and starts a search.

Parameters:
criteria - The search criteria object.
listener - The filter status listener.
Since:
BlackBerry API 6.0.0

getCriteria

Object getCriteria()
Gets the search criteria object.

Returns:
the search criteria object
Since:
BlackBerry API 6.0.0

reset

void reset()
Start a new search with the current criteria.

Since:
BlackBerry API 6.0.0

waitForComplete

void waitForComplete()
Wait until filtering is complete.

Since:
BlackBerry API 6.0.0

getLock

Object getLock()
All synchronized operations should use this lock.

Returns:
lock Object
Since:
BlackBerry API 6.0.0





Copyright 1999-2010 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. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.