net.rim.device.api.unifiedsearch.searchables.adapters
Class ExtendedSearchProvider

java.lang.Object
  extended by net.rim.device.api.unifiedsearch.searchables.adapters.RegisterableDataSource
      extended by net.rim.device.api.unifiedsearch.searchables.adapters.ExtendedSearchProvider
All Implemented Interfaces:
ExternalSearchProvider

public class ExtendedSearchProvider
extends RegisterableDataSource
implements ExternalSearchProvider

The ExtendedSearchProvider adapter allows a developer to provide a plug in mechanism for other applications using the search framework to re-route a query string from the search framework into an application.

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

Constructor Summary
Category: Signed ExtendedSearchProvider()
          Default constructor
 
Method Summary
Category: Signed  long getContentType()
          Returns the content type.
Category: Signed  Image getProviderIcon()
          Returns the provider's icon.
Category: Signed  String getProviderName()
          Returns the provider's name with the localized string "Local Search" appended to it.
Category: Signed  void search(String keywords)
          Begins a search based on the keywords supplied.
Category: Signed  void setContentType(long contentType)
          Sets the content type for the ExtendedSearchProvider
Category: Signed  void setProviderIcon(Image icon)
          Sets the ExtendedSearchProvider icon
Category: Signed  void setProviderName(String name)
          Sets the ExtendedSearchProvider name
Category: Signed  void setProviderName(StringProvider name)
          Sets the ExtendedSearchProvider name
 
Methods inherited from class net.rim.device.api.unifiedsearch.searchables.adapters.RegisterableDataSource
deregister, getListener, getRegistrationID, getRegistrationToken, register, setListener, setRegistrationID, setRegistrationToken
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface net.rim.device.api.unifiedsearch.searchables.ExternalSearchProvider
getRegistrationID, setRegistrationID
 



Constructor Detail

ExtendedSearchProvider

public ExtendedSearchProvider()
Default constructor

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


Method Detail

getContentType

public long getContentType()
Returns the content type. See SearchableContentTypeConstants for more information.

Specified by:
getContentType in interface ExternalSearchProvider
Returns:
The content type.
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

setContentType

public void setContentType(long contentType)
Sets the content type for the ExtendedSearchProvider

Parameters:
contentType -
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

setProviderIcon

public void setProviderIcon(Image icon)
Sets the ExtendedSearchProvider icon

Parameters:
icon - The image that is used as the icon for this ExtendedSearchProvider
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

getProviderIcon

public Image getProviderIcon()
Returns the provider's icon.

Specified by:
getProviderIcon in interface ExternalSearchProvider
Returns:
An icon of the provider.
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

setProviderName

public void setProviderName(String name)
Sets the ExtendedSearchProvider name

Parameters:
name - the name of the ExtendedSearchProvider 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 7.0.0

setProviderName

public void setProviderName(StringProvider name)
Sets the ExtendedSearchProvider name

Parameters:
name - the StringProvider to use for setting the name of the ExtendedSearchProvider 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 7.0.0

getProviderName

public String getProviderName()
Returns the provider's name with the localized string "Local Search" appended to it.

Specified by:
getProviderName in interface ExternalSearchProvider
Returns:
The name of the provider.
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

search

public void search(String keywords)
Begins a search based on the keywords supplied.

Specified by:
search in interface ExternalSearchProvider
Parameters:
keywords - The search keyword phrase.
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





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