|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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.
| 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 |
|---|
String getTitle()
SearchableEntity.
SearchableEntity.String getSummary()
SearchableEntity represents.
This summary may be displayed to a user.
SearchableEntity.SearchFieldCriteriaList getSearchCriteria()
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.
SearchFieldCriteriaList.Searchable getSearchable()
Searchable that knows about this entity.
Searchable object.Object getData()
SearchableEntity.
This is how other applications access the contents of the search result.
Image getIcon()
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
long getTimeStamp()
SearchableEntity.
For example, a last modification date or a creation date.
long representing a date-time value.
UiAction getUiActions(Object contextObject,
UiAction[] uiActions)
UiAction object related to this SearchableEntity.
contextObject - The relevant context used when retrieving the appropriate list of available UiActions.uiActions - An array of UiAction objects.
UiAction for this SearchableEntity;
or null if the list of actions does not contain an applicable default UiAction.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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