|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectnet.rim.device.api.unifiedsearch.searchables.adapters.SearchableDataObject
public class SearchableDataObject
This class is an abstract implementation of the SearchableEntity interface
| Constructor Summary | ||
|---|---|---|
|
SearchableDataObject()
Creates a SearchableDataObject instance. |
|
| 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()
Deprecated. This feature is no longer used by SearchableDataObject. |
|
UiAction |
getUiActions(Object contextObject,
UiAction[] uiActions)
Returns the UiAction object related to this SearchableEntity. |
|
void |
setIcon(Image icon)
|
|
void |
setSearchCriteria(SearchFieldCriteriaList criteriaList)
Sets the SearchFieldCriteriaList for this object |
|
void |
setSearchable(EntityBasedSearchableProvider searchable)
Sets the EntityBasedSearchableProvider instance that manages this object |
|
void |
setSummary(String summary)
|
|
void |
setTimeStamp(long time)
Sets the time stamp on this object |
|
void |
setTitle(String title)
|
|
void |
setUiActions(Object contextObject,
UiAction[] uiActions,
UiAction defaultUiAction)
|
|
String |
toString()
Returns a string representation of this object. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public SearchableDataObject()
SearchableDataObject instance.
| Method Detail |
|---|
public long getTimeStamp()
SearchableEntity.
For example, a last modification date or a creation date.
getTimeStamp in interface SearchableEntitylong representing a date-time value.public void setTimeStamp(long time)
time - the time in milliseconds to setpublic Image getIcon()
getIcon method. This method
provides the opportunity for an application to provide different icons
for different SearchableEntity objects.
- Specified by:
getIcon in interface SearchableEntity
- 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 7.0.0
public void setIcon(Image icon)
public Object getData()
SearchableEntity.
This is how other applications access the contents of the search result.
getData in interface SearchableEntitypublic Searchable getSearchable()
Searchable that knows about this entity.
getSearchable in interface SearchableEntitySearchable object.public void setSearchable(EntityBasedSearchableProvider searchable)
EntityBasedSearchableProvider instance that manages this object
searchable - The EntityBasedSearchableProvider instancepublic String getSummary()
SearchableEntity represents.
This summary may be displayed to a user.
getSummary in interface SearchableEntitySearchableEntity.public void setSummary(String summary)
public String getTitle()
SearchableEntity.
getTitle in interface SearchableEntitySearchableEntity.public void setTitle(String title)
public 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.
getSearchCriteria in interface SearchableEntitySearchFieldCriteriaList.public void setSearchCriteria(SearchFieldCriteriaList criteriaList)
SearchFieldCriteriaList for this object
criteriaList - the SearchFieldCriteriaList for this SearchableDataObjectpublic final UiAction[] getUiActions()
UiAction objects related to the SearchableEntity.
The default action is always returned as the first element in the array returned.
public UiAction getUiActions(Object contextObject,
UiAction[] uiActions)
UiAction object related to this SearchableEntity.
getUiActions in interface SearchableEntitycontextObject - 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.
public void setUiActions(Object contextObject,
UiAction[] uiActions,
UiAction defaultUiAction)
public String toString()
toString in class Object
|
|||||||||
| 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