net.rim.device.api.unifiedsearch.content
Class AppContentManager

java.lang.Object
  net.rim.device.api.unifiedsearch.content.AppContentManager

public abstract class AppContentManager
extends Object

Primary way an application communicates with the Unified Search Framework. Allows an application to insert, update, and delete content in the Framework's content index. Note that the Framework replies to the application through the AppContentListener interface.

While AppContentManager is an abstract class, it is not intended to be subclassed. See the getInstance method for more information about using AppContentManager.

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
	abstract void	deleteContent(SearchableEntity[] entity, AppContentListener observer, RegistrationToken token) Removes a set of SearchableEntity objects from the Unified Search Framework index.
	static AppContentManager	getInstance() Retrieves the system's AppContentManager instance.
	abstract void	insertContent(SearchableEntity[] entity, AppContentListener observer, RegistrationToken token) Submits an array of SearchableEntity objects to the Unified Search Framework to be indexed.
	abstract void	updateContent(SearchableEntity[] entity, AppContentListener observer, RegistrationToken token) Updates a set of SearchableEntity objects already indexed by the Unified Search Framework.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static final AppContentManager getInstance()

Retrieves the system's AppContentManager instance. In practice, getInstance returns a system implementation of AppContentManager that an application can use to insert, update, and delete content in the Unified Search Framework content index. For example, an application could insert content using the insertContent method: AppContentManager.getInstance().insertContent(MyEntity, MyAppContentListener, MyRegistrationToken)

Returns:

The system's AppContentManager implementation.

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

insertContent

public abstract void insertContent(SearchableEntity[] entity,
                                   AppContentListener observer,
                                   RegistrationToken token)

Submits an array of SearchableEntity objects to the Unified Search Framework to be indexed.

Parameters:

entity - The SearchableEntity objects to index.

observer - An AppContentListener to receive status notifications regarding this insert operation from the Unified Search Framework.

token - The registration token returned by the Unified Search Framework when the Searchable for the SearchableEntity was registered.

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

updateContent

public abstract void updateContent(SearchableEntity[] entity,
                                   AppContentListener observer,
                                   RegistrationToken token)

Updates a set of SearchableEntity objects already indexed by the Unified Search Framework.

Parameters:

entity - An array of SearchableEntity objects to update. The existing object will be found by matching the IDs and replacing the data in the database with the values in entity.

observer - An AppContentListener to receive status notifications regarding this insert operation from the Unified Search Framework.

token - The registration token returned by the Unified Search Framework when the Searchable for the SearchableEntity was registered.

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

deleteContent

public abstract void deleteContent(SearchableEntity[] entity,
                                   AppContentListener observer,
                                   RegistrationToken token)

Removes a set of SearchableEntity objects from the Unified Search Framework index.

Parameters:

entity - An array of SearchableEntity objects to remove from the Unified Search Framework index. The existing object will be found by matching the IDs and replacing the data in the database with the values in entity.

observer - An AppContentListener to receive status notifications regarding this insert operation from the Unified Search Framework.

token - The registration token returned by the Unified Search Framework when the Searchable for the SearchableEntity was registered.

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