OSID - osid.contact.AddressBookNotificationSession Service Interface Definition

Interface	osid.contact.AddressBookNotificationSession
Implements	`osid.OsidSession`
Description	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.
Method	canRegisterForAddressBookNotifications
Description	Tests if this user can register for `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.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	reliableAddressBookNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAddressBookNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAddressBookNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAddressBookNotification
Description	Acknowledge an address book notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewAddressBooks
Description	Register for notifications of new address books. `AddressBookReceiver.newAddressBooks()` is invoked when a new `AddressBook` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAddressBooks
Description	Registers for notification of updated address books. `AddressBookReceiver.changedAddressBooks()` is invoked when an address book is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAddressBook
Description	Registers for notification of an updated address book. `AddressBookReceiver.changedAddressBooks()` is invoked when the specified address book is changed.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook` to monitor
Errors	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAddressBooks
Description	Registers for notification of deleted address books. `AddressBookReceiver.deletedAddressBooks()` is invoked when an address book is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAddressBook
Description	Registers for notification of a deleted address book. `AddressBookReceiver.deletedAddressBooks()` is invoked when the specified address book is deleted.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook` to monitor
Errors	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAddressBookHierarchy
Description	Registers for notification of an updated address book hierarchy structure. `AddressBookReceiver.changedChildOfAddressBooks()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAddressBookHierarchyForAncestors
Description	Registers for notification of an updated address book hierarchy structure. `AddressBookReceiver.changedChildOfAddressBooks()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook` node to monitor
Errors	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAddressBookHierarchyForDescendants
Description	Registers for notification of an updated address book hierarchy structure. `AddressBookReceiver.changedChildOfAddressBooks()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`addressBookId`	the `Id` of the `AddressBook` node to monitor
Errors	NULL_ARGUMENT		`addressBookId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.