OSID - osid.authentication.AgencyNotificationSession Service Interface Definition

Interface	osid.authentication.AgencyNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.authentication.AuthenticationManager`
Used By	`osid.authentication.AuthenticationProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Agency` 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.
Method	canRegisterForAgencyNotifications
Description	Tests if this user can register for `Agency` 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	reliableAgencyNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAgencyNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAgencyNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAgencyNotification
Description	Acknowledge an agency 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	registerForNewAgencies
Description	Register for notifications of new agencies. `AgencyReceiver.newAgencies()` is invoked when a new `Agency` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAgencies
Description	Registers for notification of updated agencies. `AgencyReceiver.changedAgencies()` is invoked when an agency is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAgency
Description	Registers for notification of an updated agency. `AgencyReceiver.changedAgencies()` is invoked when the specified agency is changed.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the agency to monitor
Errors	NULL_ARGUMENT		`agencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAgencies
Description	Registers for notification of deleted agencies. `AgencyReceiver.deletedAgencies()` is invoked when an agency is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAgency
Description	Registers for notification of a deleted agency. `AgencyReceiver.deletedAgencies()` is invoked when the specified agency is deleted.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the agency to monitor
Errors	NULL_ARGUMENT		`agencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAgencyHierarchy
Description	Registers for notification of an updated agency hierarchy structure. `AgencyReceiver.changedChildOfAgencies()` 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	registerForChangedAgencyHierarchyForAncestors
Description	Registers for notification of an updated agency hierarchy structure. `AgencyReceiver.changedChildOfAgencies()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the `Agency` node to monitor
Errors	NULL_ARGUMENT		`agencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAgencyHierarchyForDescendants
Description	Registers for notification of an updated agency hierarchy structure. `AgencyReceiver.changedChildOfAgencies()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`agencyId`	the `Id` of the `Agency` node to monitor
Errors	NULL_ARGUMENT		`agencyId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.