net.rim.device.api.unifiedsearch.registry
Class SearchRegistry

java.lang.Object
  net.rim.device.api.unifiedsearch.registry.SearchRegistry

public abstract class SearchRegistry
extends Object

Registers Searchable objects in the Unified Search Framework. An application registers at least one class that implements a Searchable or an ExternalSearchProvider interface. See also: EntityBasedSearchable.

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
	abstract boolean	deregister(RegistrationToken token) Removes a registered Searchable from the Unified Search Framework.
	static SearchRegistry	getInstance() Returns an instance of SearchRegistry.
	abstract RegistrationToken	register(ExternalSearchProvider provider) Adds an implementation of ExternalSearchProvider to the Unified Search Framework.
	abstract RegistrationToken	register(Searchable searchable) Adds an implementation of Searchable to the Unified Search Framework.

Methods inherited from class java.lang.Object

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

Method Detail

register

public abstract RegistrationToken register(Searchable searchable)

Adds an implementation of Searchable to the Unified Search Framework.

Parameters:

searchable - The component to be registered in the Unified Search Framework. NOTE: Invoking this method is the same as register( searchable, true );

Returns:

A RegistrationToken used when an application registers content. See AppContentManager for more information.

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

register

public abstract RegistrationToken register(ExternalSearchProvider provider)

Adds an implementation of ExternalSearchProvider to the Unified Search Framework.

Parameters:

provider - The component to be registered as a search provider.

Returns:

A RegistrationToken used when an application registers content.

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

deregister

public abstract boolean deregister(RegistrationToken token)

Removes a registered Searchable from the Unified Search Framework.

Parameters:

token - The RegistrationToken, issued at the time of registration, that identifies the source of the request.

Returns:

true if the Searchable was successfully removed; false otherwise.

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

getInstance

public static final SearchRegistry getInstance()

Returns an instance of SearchRegistry. Only one instance of SearchRegistry is available per process.

Returns:

A SearchRegistry instance

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