net.rim.device.api.unifiedsearch
Class SearchResponse

java.lang.Object
  net.rim.device.api.unifiedsearch.SearchResponse

public final class SearchResponse
extends Object

A response the Unified Search Framework returns when an application initiates a search operation.

See Also:

UnifiedSearchServices

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 6.0.0

Method Summary
	SearchField[]	getSearchFields(Searchable searchable) Returns SearchField objects that matched keywords.
	Hashtable	getSearchResults(Searchable searchable) Returns a Hashtable which maps SearchField objects to the search results for a particular Searchable.
	Object[]	getSearchResults(Searchable searchable, SearchField field) Returns the search results for a particular Searchable and SearchField.
	Searchable[]	getSearchables() Returns Searchable objects where keywords matched some fields in its SearchFields.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSearchables

public Searchable[] getSearchables()

Returns Searchable objects where keywords matched some fields in its SearchFields.

Returns:

An array of Searchable objects.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 6.0.0

getSearchFields

public SearchField[] getSearchFields(Searchable searchable)

Returns SearchField objects that matched keywords.

Parameters:

searchable - The Searchable that manages the matching search fields.

Returns:

An array of SearchField objects or returns null if 'searchable' is null or 'searchable' is not found in the results.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 6.0.0

getSearchResults

public Object[] getSearchResults(Searchable searchable,
                                 SearchField field)

Returns the search results for a particular Searchable and SearchField.

Parameters:

searchable - The Searchable that manages the matching search field.

field - The SearchField that matched the keywords.

Returns:

An array of search results for the specified Searchable and SearchField.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 6.0.0

getSearchResults

public Hashtable getSearchResults(Searchable searchable)

Returns a Hashtable which maps SearchField objects to the search results for a particular Searchable.

Parameters:

searchable - The Searchable that manages the matching search fields.

Returns:

A Hashtable of search results mapped to the corresponding SearchField or null if 'searchable' is null.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 6.0.0