OSID - osid.contact.rules.ContactEnablerNotificationSession Service Interface Definition

Interface	osid.contact.rules.ContactEnablerNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.contact.rules.ContactRulesManager`
Used By	`osid.contact.rules.ContactRulesProxyManager`
Description	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`.
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	canRegisterForContactEnablerNotifications
Description	Tests if this user can register for `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.
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 enablers 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 notifications to this address book only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableContactEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeContactEnablerNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableContactEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeContactEnablerNotification
Description	Acknowledge a contact enabler 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	registerForNewContactEnablers
Description	Register for notifications of new contact enablers. `ContactEnablerReceiver.newContactEnablers()` is invoked when a new `ContactEnabler` appears in this address book.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedContactEnablers
Description	Registers for notification of updated contact enablers. `ContactEnablerReceiver.changedContactEnablers()` is invoked when a contact enabler in this address book is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedContactEnabler
Description	Registers for notification of an updated contact enabler. `ProvisionableReceiver.changedContactEnablers()` is invoked when the specified contact enabler in this address book is changed.
Parameters	`osid.id.Id`	`contactEnablerId`	the `Id` of the `ContactEnabler` to monitor
Errors	NULL_ARGUMENT		`contactEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedContactEnablers
Description	Registers for notification of deleted contact enablers. `ContactEnablerReceiver.deletedContactEnablers()` is invoked when a contact enabler is deleted or removed from this address book.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedContactEnabler
Description	Registers for notification of a deleted contact enabler. `ContactEnablerReceiver.deletedContactEnablers()` is invoked when the specified contact enabler is deleted or removed from this address book.
Parameters	`osid.id.Id`	`contactEnablerId`	the `Id` of the `ContactEnabler` to monitor
Errors	NULL_ARGUMENT		`contactEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.