net.rim.device.api.unifiedsearch.searchables
Interface EntityBasedSearchable

All Superinterfaces:

Searchable

public interface EntityBasedSearchable
extends Searchable

Defines the basic behavior an application should implement to manage its SearchableEntity objects in the Unified Search Framework.

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

Field Summary

Fields inherited from interface net.rim.device.api.unifiedsearch.searchables.Searchable

PRIORITY_MAX, PRIORITY_MIN, PRIORITY_NORMAL

Method Summary
	SearchableEntity[]	getSearchableEntities() Returns an array of SearchableEntity objects that a Searchable wants to publish.

Methods inherited from interface net.rim.device.api.unifiedsearch.searchables.Searchable

defineSupportedSearchFields, getComparator, getIcon, getName, getPriority, getPrivacyLevel, getRegistrationID, getType, getUiActions, load, pause, resume, setRegistrationID

Method Detail

getSearchableEntities

SearchableEntity[] getSearchableEntities()

Returns an array of SearchableEntity objects that a Searchable wants to publish.

Returns:

An array of searchable entities. If there are no SearchableEntity objects to return, return a zero-length array (e.g. return new SearchableEntity[0];).

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