|
|||||||||
| 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.RegisterableDataSource
public class RegisterableDataSource
A RegisterableDataSource is an object that can be registered with the search framework.
| Method Summary | ||
|---|---|---|
|
boolean |
deregister()
De-registers the RegisterableDataSource instance. |
|
NotificationListener |
getListener()
Gets the NotificationListener associated with this RegisterableDataSource. |
|
long |
getRegistrationID()
Returns the registration ID. |
|
RegistrationToken |
getRegistrationToken()
Returns the assigned RegistrationToken or null if has not yet been set. |
|
RegistrationToken |
register()
Registers the RegisterableDataSource instance. |
|
void |
setListener(NotificationListener observer)
Set the observer. |
|
void |
setRegistrationID(long id)
This method is called by the framework when the RegisterableDataSource instance undergoes a registration operation. |
|
void |
setRegistrationToken(RegistrationToken token)
Set the RegistrationToken associated with this RegisterableDataSource instance. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Method Detail |
|---|
public final void setRegistrationID(long id)
RegisterableDataSource instance undergoes a registration operation.
id - the registration id of the RegisterableDataSourcepublic final long getRegistrationID()
public final void setRegistrationToken(RegistrationToken token)
token - The RegistrationToken assigned to this objectpublic final RegistrationToken getRegistrationToken()
RegistrationToken or null if has not yet been set.
public final boolean deregister()
throws RegistrationException
RegisterableDataSource instance.
RegistrationException - if errors are encountered while performing the de-registration
public final RegistrationToken register()
throws RegistrationException
RegisterableDataSource instance.
RegisterableDataSource
RegistrationException - if an error occurs during registrationpublic final void setListener(NotificationListener observer)
RegisterableDataSource will receive notifications via this
object. When no longer needed, this method should be invoked with a null parameter to release the
NotificationListener reference.
observer - the NotificationListener that will receive applicable eventspublic final NotificationListener getListener()
NotificationListener associated with this RegisterableDataSource.
NotificationListener observer; It can be null if not set already.
|
|||||||||
| 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