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

java.lang.Object
  extended by 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
Category: Signed abstract  boolean deregister(RegistrationToken token)
          Removes a registered Searchable from the Unified Search Framework.
Category: Signed static SearchRegistry getInstance()
          Returns an instance of SearchRegistry.
Category: Signed abstract  RegistrationToken register(ExternalSearchProvider provider)
          Adds an implementation of ExternalSearchProvider to the Unified Search Framework.
Category: Signed abstract  RegistrationToken register(Searchable searchable)
          Adds an implementation of Searchable to the Unified Search Framework.
Category: Signed abstract  RegistrationToken register(Searchable searchable, boolean encryptable)
          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(Searchable searchable,
                                           boolean encryptable)
Adds an implementation of Searchable to the Unified Search Framework.

Parameters:
searchable - The component to be registered in the Unified Search Framework.
encryptable - If set to true, the keywords associated with the searchable being registered will be encrypted if content protection is enabled
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 7.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





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