public interface ContactEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to ContactEnabler
objects in this AddressBook.
This also includes existing ContactEnablers
that
may appear or disappear due to changes in the AddressBook
hierarchy, This session is intended for consumers needing to synchronize
their state with this service without the use of polling. Notifications
are cancelled when this session is closed.
The two views defined in this session correspond to the views in the
ContactEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeContactEnablerNotification(Id notificationId)
Acknowledge a contact enabler notification.
|
boolean |
canRegisterForContactEnablerNotifications()
Tests if this user can register for
ContactEnabler
notifications. |
AddressBook |
getAddressBook()
Gets the
AddressBook associated with this session. |
Id |
getAddressBookId()
Gets the
AddressBook Id associated with
this session. |
void |
registerForChangedContactEnabler(Id contactEnablerId)
Registers for notification of an updated contact enabler.
|
void |
registerForChangedContactEnablers()
Registers for notification of updated contact enablers.
|
void |
registerForDeletedContactEnabler(Id contactEnablerId)
Registers for notification of a deleted contact enabler.
|
void |
registerForDeletedContactEnablers()
Registers for notification of deleted contact enablers.
|
void |
registerForNewContactEnablers()
Register for notifications of new contact enablers.
|
void |
reliableContactEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableContactEnablerNotifications()
Unreliable notifications are desired.
|
void |
useFederatedAddressBookView()
Federates the view for methods in this session.
|
void |
useIsolatedAddressBookView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAddressBookId()
AddressBook
Id
associated with
this session. AddressBook Id
associated with this sessionmandatory
- This method must be implemented. AddressBook getAddressBook() throws OperationFailedException, PermissionDeniedException
AddressBook
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForContactEnablerNotifications()
ContactEnabler
notifications. A return of true does not guarantee successful
authorization. A return of false indicates that it is known all
methods in this session will result in a PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer notification operations. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedAddressBookView()
mandatory
- This method is must be implemented. void useIsolatedAddressBookView()
mandatory
- This method is must be implemented. void reliableContactEnablerNotifications()
acknowledgeContactEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableContactEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeContactEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewContactEnablers() throws OperationFailedException, PermissionDeniedException
ContactEnablerReceiver.newContactEnablers()
is invoked when a
new ContactEnabler
appears in this address book.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedContactEnablers() throws OperationFailedException, PermissionDeniedException
ContactEnablerReceiver.changedContactEnablers()
is invoked
when a contact enabler in this address book is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedContactEnabler(Id contactEnablerId) throws OperationFailedException, PermissionDeniedException
ProvisionableReceiver.changedContactEnablers()
is invoked when
the specified contact enabler in this address book is changed.contactEnablerId
- the Id
of the
ContactEnabler
to monitorNullArgumentException
- contactEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedContactEnablers() throws OperationFailedException, PermissionDeniedException
ContactEnablerReceiver.deletedContactEnablers()
is invoked
when a contact enabler is deleted or removed from this address book.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedContactEnabler(Id contactEnablerId) throws OperationFailedException, PermissionDeniedException
ContactEnablerReceiver.deletedContactEnablers()
is invoked
when the specified contact enabler is deleted or removed from this
address book.contactEnablerId
- the Id
of the
ContactEnabler
to monitorNullArgumentException
- contactEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.