|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface NotificationListener
Defines the behavior an application should implement to receive notifications
about search operations. All methods in this class return an Object
(except error()). Compare resultType to the constants defined in
this class to determine what type of object the Unified Search Framework
returns.
| Field Summary | ||
|---|---|---|
|
static int |
TYPE_SEARCHABLE
The object returned is a Searchable. |
|
static int |
TYPE_SEARCH_RESPONSE
Used if the object being passed is a SearchResponse. |
| Method Summary | ||
|---|---|---|
|
void |
completed(Object results,
int resultType)
Notifies the listener that the search operation is complete. |
|
void |
error(Exception exception)
Notifies the listener that the Unified Search Framework encountered a problem while attempting the requested search. |
|
void |
partiallyCompleted(Object results,
Exception exception,
int resultType)
Notifies the listener that a partial search result is available in results. |
|
void |
update(Object results,
int resultType)
Updates the listener with a set of matching objects. |
| Field Detail |
|---|
static final int TYPE_SEARCHABLE
Searchable.
static final int TYPE_SEARCH_RESPONSE
SearchResponse.
This will always be the case if a UnifiedSearchField is used to perform searches.
| Method Detail |
|---|
void update(Object results,
int resultType)
results - The partial search result.resultType - The type of result returned. See the constants defined in
NotificationListener for a list of result types.
void completed(Object results,
int resultType)
results - The search result.resultType - The type of result returned. See the constants defined in
NotificationListener for a list of result types.
void partiallyCompleted(Object results,
Exception exception,
int resultType)
results.
The search operation was stopped, paused or interrupted.
results - The partial search result.exception - The Exception that stopped the search operation;
null if the search stopped for any other reason.resultType - The type of result returned. See the constants defined in
NotificationListener for a list of result types.void error(Exception exception)
Exception.
exception - The reason that the search operation failed.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 1999-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal