net.rim.device.api.unifiedsearch.searchables
Interface Searchable

All Known Subinterfaces:
EntityBasedSearchable

public interface Searchable

Defines the basic behavior that an application must implement to provide searchable data 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

Field Summary
Category: Signed static int PRIORITY_MAX
          Static value to define the maximum preferred priority.
Category: Signed static int PRIORITY_MIN
          Static value to define the minimum preferred priority.
Category: Signed static int PRIORITY_NORMAL
          Static value to define the normal preferred priority.
 
Method Summary
Category: Signed  SearchField[] defineSupportedSearchFields()
          Returns an array of searchable fields controlled by this Searchable.
Category: Signed  Comparator getComparator()
          Returns an application-specific comparator for the searches performed on the data within that application.
Category: Signed  Image getIcon()
          Returns an icon for the Searchable.
Category: Signed  String getName()
          Returns a human-readable string that represents the Searchable component.
Category: Signed  int getPriority()
          Returns the preferred priority level for the Searchable.
Category: Signed  int getPrivacyLevel()
          Returns the ExposureLevel of this Searchable.
Category: Signed  long getRegistrationID()
          Returns the registration ID.
Category: Signed  long getType()
          Returns the location and content type of the Searchable.
Category: Signed  UiAction getUiActions(SearchableEntity[] entities, Object contextObject, UiAction[] uiActions)
          Returns a UiAction for multiple SearchableEntity objects.
Category: Signed  void load(NotificationListener callback, int loadType)
          Begins loading searchable data into the Unified Search Framework.
Category: Signed  void pause()
          Pauses any outstanding load operations.
Category: Signed  void resume()
          Resumes any outstanding load operations.
Category: Signed  void setRegistrationID(long id)
          Sets the registration ID.
 



Field Detail

PRIORITY_MIN

static final int PRIORITY_MIN
Static value to define the minimum preferred priority.

See Also:
Constant Field Values
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

PRIORITY_NORMAL

static final int PRIORITY_NORMAL
Static value to define the normal preferred priority.

See Also:
Constant Field Values
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

PRIORITY_MAX

static final int PRIORITY_MAX
Static value to define the maximum preferred priority.

See Also:
Constant Field Values
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 Detail

getName

String getName()
Returns a human-readable string that represents the Searchable component.

Returns:
A string that represents the Searchable.
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 icon for the Searchable.

Returns:
An Image used to distinguish the Searchable in the user 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 6.0.0

getPriority

int getPriority()
Returns the preferred priority level for the Searchable.

Returns:
A value between Searchable.PRIORITY_MIN and Searchable.PRIORITY_MAX
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

getType

long getType()
Returns the location and content type of the Searchable.

Returns:
See SearchableContentTypeConstants for more information about content type masks.
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

load

void load(NotificationListener callback,
          int loadType)
Begins loading searchable data into the Unified Search Framework. The Searchable may choose to update the Framework via the NotificationListener reference, or it may choose to create its entries using AppContentManager.

After this method is invoked, the Framework may invoke pause(). In this a scenario, load should attempt to promptly complete any unit of activity, save its current state, then go dormant. It is preferred that the Searchable enters a wait state with Object.wait() to conserve processor use.

Parameters:
callback - The object to notify of loading progress. This searchable must notify the Unified Search Framework when loading is complete by invoking a command similar to: observer.completed(this, null, NotificationListener.TYPE_SEARCHABLE).
loadType - A SearchableEventConstants constant that indicates why the load event was triggered.
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

pause

void pause()
Pauses any outstanding load operations. Searchable must halt the loading operation as soon as possible. It is preferred that the object enter a wait state using Object.wait(). If resume() is invoked after pause(), the load operation should continue from where it left off.

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

resume

void resume()
Resumes any outstanding load operations.

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

defineSupportedSearchFields

SearchField[] defineSupportedSearchFields()
Returns an array of searchable fields controlled by this Searchable. Allows the Unified Search Framework to discover and optimize what fields are queryable.

Returns:
An Array of SearchField objects that describe the fields this Searchable supports.
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

setRegistrationID

void setRegistrationID(long id)
Sets the registration ID.

Parameters:
id - An ID assigned by SearchRegistry.
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

getRegistrationID

long getRegistrationID()
Returns the registration ID.

Returns:
An ID assigned by SearchRegistry.
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

getPrivacyLevel

int getPrivacyLevel()
Returns the ExposureLevel of this Searchable.

Returns:
The ExposureLevel
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

getComparator

Comparator getComparator()
Returns an application-specific comparator for the searches performed on the data within that application.

Returns:
The Comparator used by the Unified Search Framework to sort search results from this Searchable.
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(SearchableEntity[] entities,
                      Object contextObject,
                      UiAction[] uiActions)
Returns a UiAction for multiple SearchableEntity objects.

Parameters:
entities - An Array of SearchableEntity objects.
contextObject - The context of the search. Used to determine the appropriate list of available UiAction.
uiActions - An array of UiAction objects. Initially this Array, is empty and will be filled with all applicable UiActions, including the default UiAction if not null.
Returns:
The default UiAction for the SearchableEntities; or null if the list of UiActions does not contain an applicable 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-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.