net.rim.device.api.unifiedsearch.entity
Interface SearchableEntity

All Known Implementing Classes:
SearchableDataObject

public interface SearchableEntity

Defines the basic behavior that searchable data should implement. An implementation of SearchableEntity is the primary way to expose data to other applications through 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

Method Summary
Category: Signed  Object getData()
          Returns the application-native object controlled by a SearchableEntity.
Category: Signed  Image getIcon()
          Returns an entity-specific icon.
Category: Signed  SearchFieldCriteriaList getSearchCriteria()
          Returns a SearchFieldCriteriaList object that contains the search fields and their associated keywords.
Category: Signed  Searchable getSearchable()
          Returns the Searchable that knows about this entity.
Category: Signed  String getSummary()
          Returns a summary of the data the SearchableEntity represents.
Category: Signed  long getTimeStamp()
          Returns a time value relevant to the SearchableEntity.
Category: Signed  String getTitle()
          Returns the title of the SearchableEntity.
Category: Signed  UiAction getUiActions(Object contextObject, UiAction[] uiActions)
          Returns the UiAction object related to this SearchableEntity.
 



Method Detail

getTitle

String getTitle()
Returns the title of the SearchableEntity.

Returns:
The title of the SearchableEntity.
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

getSummary

String getSummary()
Returns a summary of the data the SearchableEntity represents. This summary may be displayed to a user.

Returns:
The summary of the SearchableEntity.
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

getSearchCriteria

SearchFieldCriteriaList getSearchCriteria()
Returns a SearchFieldCriteriaList object that contains the search fields and their associated keywords. Note: It is highly recommended to build SearchFieldCriteriaList object on demand instead of holding its reference. Once indexing of the data is complete the SearchFieldCriteriaList object will be deleted.

Returns:
See SearchFieldCriteriaList.
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

getSearchable

Searchable getSearchable()
Returns the Searchable that knows about this entity.

Returns:
A Searchable object.
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

getData

Object getData()
Returns the application-native object controlled by a SearchableEntity. This is how other applications access the contents of the search result.

Returns:
The application-native data associated with this searchable entity.
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

getIcon

Image getIcon()
Returns an entity-specific icon. Often, the applications will want to return the same icon provided by the getIcon method. This method provides the opportunity for an application to provide different icons for different SearchableEntity objects.

Returns:
An entity-specific icon related to this SearchableEntity; or null if none is assigned.
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

getTimeStamp

long getTimeStamp()
Returns a time value relevant to the SearchableEntity. For example, a last modification date or a creation date.

Returns:
A long representing a date-time value.
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

getUiActions

UiAction getUiActions(Object contextObject,
                      UiAction[] uiActions)
Returns the UiAction object related to this SearchableEntity.

Parameters:
contextObject - The relevant context used when retrieving the appropriate list of available UiActions.
uiActions - An array of UiAction objects.
Returns:
The default UiAction for this SearchableEntity; or null if the list of actions does not contain an applicable default UiAction.
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