OSID - osid.contact.AddressNotificationSession Service Interface Definition

Interface	osid.contact.AddressNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Address` 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 `Address` object itself. Adding and removing contacts result in notifications available from the notification session for contacts.
Method	getAddressBookId
Description	Gets the `AddressBook` `Id` associated with this session.
Return	`osid.id.Id`		the `AddressBook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getAddressBook
Description	Gets the `AddressBook` associated with this session.
Return	`osid.contact.AddressBook`		the address book
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForAddressNotifications
Description	Tests if this user can register for `Address` 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	useFederatedAddressBookView
Description	Federates the view for methods in this session. A federated view will include addresses in address books which are children of this address book in the address book hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedAddressBookView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this address book only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableAddressNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAddressNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAddressNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAddressNotification
Description	Acknowledge an address 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	registerForNewAddresses
Description	Register for notifications of new addresses. `AddressReceiver.newAddresses()` is invoked when a new `Address` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAddresses
Description	Registers for notification of updated addresses. `AddressReceiver.changedAddresses()` is invoked when an address is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAddress
Description	Registers for notification of an updated address. `AddressReceiver.changedAddresses()` is invoked when the specified address is changed.
Parameters	`osid.id.Id`	`addressId`	the `Id` of the `Address` to monitor
Errors	NULL_ARGUMENT		`addressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAddresses
Description	Registers for notification of deleted addresses. `AddressReceiver.deletedAddresses()` is invoked when an address is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAddress
Description	Registers for notification of a deleted address. `AddressReceiver.deletedAddresses()` is invoked when the specified address is deleted.
Parameters	`osid.id.Id`	`addressId`	the `Id` of the `Address` to monitor
Errors	NULL_ARGUMENT		`addressId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.