OSID - osid.personnel.RealmNotificationSession Service Interface Definition

Interface	osid.personnel.RealmNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Realm` 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 `Realm` object itself. Adding and removing persons result in notifications available from the notification session for persons.
Method	canRegisterForRealmNotifications
Description	Tests if this user can register for `Realm` 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	registerForNewRealms
Description	Register for notifications of new realms. `RealmReceiver.newRealm()` is invoked when a new `Realm` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRealmAncestors
Description	Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified realm. `RealmReceiver.newAncestorRealms()` is invoked when the specified realm node gets a new ancestor.
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm` node to monitor
Errors	NULL_ARGUMENT		`realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRealmDescendants
Description	Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified realm. `RealmReceiver.newDescendantRealm()` is invoked when the specified realm node gets a new descendant.
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm` node to monitor
Errors	NULL_ARGUMENT		`realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRealms
Description	Registers for notification of updated realms. `RealmReceiver.changedRealms()` is invoked when a realm is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRealm
Description	Registers for notification of an updated realm. `RealmReceiver.changedRealms()` is invoked when the specified realm is changed.
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm` to monitor
Errors	NULL_ARGUMENT		`realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRealms
Description	Registers for notification of deleted realms. `RealmReceiver.deletedRealms()` is invoked when a realm is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRealm
Description	Registers for notification of a deleted realm. `RealmReceiver.deletedRealms()` is invoked when the specified realm is deleted.
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm` to monitor
Errors	NULL_ARGUMENT		`realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRealmAncestors
Description	Registers for notification of an updated hierarchy structure that removes an ancestor of the specified realm. `RealmReceiver.deletedAncestorRealm()` is invoked when the specified realm node loses an ancestor.
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm` to monitor
Errors	NULL_ARGUMENT		`realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRealmDescendants
Description	Registers for notification of an updated hierarchy structure that removes a descendant of the specified realm. `RealmReceiver.deletedDescendantRealm()` is invoked when the specified realm node loses a descendant.
Parameters	`osid.id.Id`	`realmId`	the `Id` of the `Realm` to monitor
Errors	NULL_ARGUMENT		`realmId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.