public interface AddressBookNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to AddressBook
objects. 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.
Notifications are triggered with changes to the AddressBook
object itself. Adding and removing contacts result in
notifications available from the notification session for contacts.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForAddressBookNotifications()
Tests if this user can register for
AddressBook
notifications. |
void |
registerForChangedAddressBook(Id addressBookId)
Registers for notification of an updated address book.
|
void |
registerForChangedAddressBooks()
Registers for notification of updated address books.
|
void |
registerForDeletedAddressBook(Id addressBookId)
Registers for notification of a deleted address book.
|
void |
registerForDeletedAddressBookAncestors(Id addressBookId)
Registers for notification of an updated hierarchy structure that
removes an ancestor of the specified address book
AddressBookReceiver.deletedAncestor() is invoked when the
specified address book node loses an ancestor. |
void |
registerForDeletedAddressBookDescendants(Id addressBookId)
Registers for notification of an updated hierarchy structure that
removes a descendant of the specified address book.
|
void |
registerForDeletedAddressBooks()
Registers for notification of deleted address books.
|
void |
registerForNewAddressBookAncestors(Id addressBookId)
Registers for notification of an updated hierarchy structure that
introduces a new ancestor of the specified address book.
|
void |
registerForNewAddressBookDescendants(Id addressBookId)
Registers for notification of an updated hierarchy structure that
introduces a new descendant of the specified address book.
|
void |
registerForNewAddressBooks()
Register for notifications of new address books.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForAddressBookNotifications()
AddressBook
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 registerForNewAddressBooks() throws OperationFailedException, PermissionDeniedException
AddressBookReceiver.newAddressBook()
is invoked when a new
AddressBook
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAddressBookAncestors(Id addressBookId) throws OperationFailedException, PermissionDeniedException
AddressBookReceiver.newAncestorAddressBook()
is invoked when
the specified address book node gets a new ancestor.addressBookId
- the Id
of the AddressBook
node to monitorNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAddressBookDescendants(Id addressBookId) throws OperationFailedException, PermissionDeniedException
AddressBookReceiver.newDescendantAddressBook()
is invoked when
the specified address book node gets a new descendant.addressBookId
- the Id
of the AddressBook
node to monitorNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAddressBooks() throws OperationFailedException, PermissionDeniedException
AddressBookReceiver.changedAddressBook()
is invoked when an
address book is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAddressBook(Id addressBookId) throws OperationFailedException, PermissionDeniedException
AddressBookReceiver.changedAddressBook()
is invoked when the
specified address book is changed.addressBookId
- the Id
of the AddressBook
to monitorNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAddressBooks() throws OperationFailedException, PermissionDeniedException
AddressBookReceiver.deletedAddressBook()
is invoked when an
address book is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAddressBook(Id addressBookId) throws OperationFailedException, PermissionDeniedException
AddressBookReceiver.deletedAddressBook()
is invoked when the
specified address book is deleted.addressBookId
- the Id
of the AddressBook
to monitorNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAddressBookAncestors(Id addressBookId) throws OperationFailedException, PermissionDeniedException
AddressBookReceiver.deletedAncestor()
is invoked when the
specified address book node loses an ancestor.addressBookId
- the Id
of the AddressBook
to monitorNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAddressBookDescendants(Id addressBookId) throws OperationFailedException, PermissionDeniedException
AddressBookReceiver.deletedDescendant()
is invoked when the
specified address book node loses a descendant.addressBookId
- the Id
of the AddressBook
to monitorNullArgumentException
- addressBookId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.