OSID - osid.personnel.PersonNotificationSession Service Interface Definition

Interface	osid.personnel.PersonNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.personnel.PersonnelManager`
Used By	`osid.personnel.PersonnelProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Person` 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	getRealmId
Description	Gets the `Realm` `Id` associated with this session.
Return	`osid.id.Id`		the `Realm Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRealm
Description	Gets the `Realm` associated with this session.
Return	`osid.personnel.Realm`		the realm
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForPersonNotifications
Description	Tests if this user can register for `Person` 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	useFederatedRealmView
Description	Federates the view for methods in this session. A federated view will include notifications for persons in realms which are children of this realm in the realm hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedRealmView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this realm only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliablePersonNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgePersonNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliablePersonNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgePersonNotification
Description	Acknowledge a person 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	registerForNewPersons
Description	Register for notifications of new persons. `PersonReceiver.newPersons()` is invoked when a new `Person` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPersons
Description	Registers for notification of updated persons. `PersonReceiver.changedPersons()` is invoked when a person in this realm is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPerson
Description	Registers for notification of an updated person. `PersonReceiver.changedPersons()` is invoked when the specified person in this realm is changed.
Parameters	`osid.id.Id`	`personId`	the `Id` of the `Person` to monitor
Errors	NOT_FOUND		a person was not found identified by the given `Id`
	NULL_ARGUMENT		`personId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPersons
Description	Registers for notification of deleted persons. `PersonReceiver.deletedPersons()` is invoked when a person is removed from this realm.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPerson
Description	Registers for notification of a deleted person. `PersonReceiver.deletedPersons()` is invoked when the specified person is removed from this realm.
Parameters	`osid.id.Id`	`personId`	the `Id` of the `Person` to monitor
Errors	NOT_FOUND		a person was not found identified by the given `Id`
	NULL_ARGUMENT		`personId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.