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


public interface ExternalSearchProvider

Defines the basic behavior that an external search provider should implement. An external search provider is another application or network server that provides a search service.

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  long getContentType()
          Returns the content type.
Category: Signed  Image getProviderIcon()
          Returns the provider's icon.
Category: Signed  String getProviderName()
          Returns the provider's name.
Category: Signed  long getRegistrationID()
          Returns the registration ID for this provider.
Category: Signed  void search(String keywords)
          Begins a search based on the keywords supplied.
Category: Signed  void setRegistrationID(long id)
          Sets the registration ID for this provider at the time of registration.
 



Method Detail

getProviderName

String getProviderName()
Returns the provider's name.

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 6.0.0

getProviderIcon

Image getProviderIcon()
Returns the provider's icon.

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 6.0.0

getContentType

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

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 6.0.0

search

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

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 6.0.0

getRegistrationID

long getRegistrationID()
Returns the registration ID for this provider.

Returns:
The registration ID.
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

setRegistrationID

void setRegistrationID(long id)
Sets the registration ID for this provider at the time of registration.

Parameters:
id - The registration ID generated by SearchRegistry.
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-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.