net.rim.device.api.unifiedsearch.searchables.adapters
Class SearchableDataObject
java.lang.Object
net.rim.device.api.unifiedsearch.searchables.adapters.SearchableDataObject
- All Implemented Interfaces:
- SearchableEntity
public class SearchableDataObject
- extends Object
- implements SearchableEntity
This class is an implementation of the SearchableEntity interface.
- 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
SearchableDataObject
public SearchableDataObject()
- Creates a
SearchableDataObject instance.
- 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
getTimeStamp
public long getTimeStamp()
- Returns a time value relevant to the
SearchableEntity.
For example, a last modification date or a creation date.
- Specified by:
getTimeStamp in interface SearchableEntity
- 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 7.0.0
setTimeStamp
public void setTimeStamp(long time)
- Sets the time stamp on this object.
- Parameters:
time - the time in milliseconds to set- 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
getIcon
public 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.
- Specified by:
getIcon in interface SearchableEntity
- Returns:
- An entity-specific icon related to this
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 7.0.0
setIcon
public void setIcon(Image icon)
-
- 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
getData
public Object getData()
- Returns the application-native object controlled by a
SearchableEntity.
This is how other applications access the contents of the search result.
- Specified by:
getData in interface SearchableEntity
- 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 7.0.0
getSearchable
public Searchable getSearchable()
- Returns the
Searchable that knows about this entity.
- Specified by:
getSearchable in interface SearchableEntity
- 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 7.0.0
setSearchable
public void setSearchable(EntityBasedSearchableProvider searchable)
- Sets the
EntityBasedSearchableProvider instance that manages this object.
- Parameters:
searchable - The EntityBasedSearchableProvider instance- 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
getSummary
public String getSummary()
- Returns a summary of the data the
SearchableEntity represents.
This summary may be displayed to a user.
- Specified by:
getSummary in interface SearchableEntity
- 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 7.0.0
setSummary
public void setSummary(String summary)
-
- 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
getTitle
public String getTitle()
- Returns the title of the
SearchableEntity.
- Specified by:
getTitle in interface 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 7.0.0
setTitle
public void setTitle(String title)
-
- 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
getSearchCriteria
public 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.
- Specified by:
getSearchCriteria in interface SearchableEntity
- 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 7.0.0
setSearchCriteria
public void setSearchCriteria(SearchFieldCriteriaList criteriaList)
- Sets the
SearchFieldCriteriaList for this object.
- Parameters:
criteriaList - the SearchFieldCriteriaList for this SearchableDataObject- 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
getUiActions
public final UiAction[] getUiActions()
- Deprecated. This feature is no longer used by SearchableDataObject.
- Returns all
UiAction objects related to the SearchableEntity.
The default action is always returned as the first element in the array returned.
- 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
getUiActions
public UiAction getUiActions(Object contextObject,
UiAction[] uiActions)
- Returns the
UiAction object related to this SearchableEntity.
- Specified by:
getUiActions in interface 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 7.0.0
setUiActions
public void setUiActions(Object contextObject,
UiAction[] uiActions,
UiAction defaultUiAction)
-
- 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
toString
public String toString()
- Returns a string representation of this object. Override to implement a more appropriate string.
- Overrides:
toString in class Object
- Returns:
- a String describing this 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 7.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