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

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
	Object	getData() Returns the application-native object controlled by a SearchableEntity.
	Image	getIcon() Returns an entity-specific icon.
	SearchFieldCriteriaList	getSearchCriteria() Returns a SearchFieldCriteriaList object that contains the search fields and their associated keywords.
	Searchable	getSearchable() Returns the Searchable that knows about this entity.
	String	getSummary() Returns a summary of the data the SearchableEntity represents.
	long	getTimeStamp() Returns a time value relevant to the SearchableEntity.
	String	getTitle() Returns the title of the SearchableEntity.
	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. Holding a reference of SearchFieldCriteriaList object within SearchbleEntity object can potentially cause 'Too Many Objects Created' exception thrown by JVM.

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