OSID - osid.personnel.AppointmentNotificationSession Service Interface Definition

Interface	osid.personnel.AppointmentNotificationSession
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 `Appointment` 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	canRegisterForAppointmentNotifications
Description	Tests if this user can register for `Appointment` 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 appointmentss 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	reliableAppointmentNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAppointmentNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAppointmentNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAppointmentNotification
Description	Acknowledge an appointment 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	registerForNewAppointments
Description	Register for notifications of new appointments. `AppointmentReceiver.newAppointments()` is invoked when a new `Appointment` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewAppointmentsForPerson
Description	Register for notifications of new appointments for the given person `Id`. `AppointmentReceiver.newAppointments()` is invoked when a new `Appointment` appears in this realm.
Parameters	`osid.id.Id`	`personId`	the person to monitor
Errors	NULL_ARGUMENT		`personId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewAppointmentsForPosition
Description	Register for notifications of new appointments for the given position `Id`. `AppointmentReceiver.newAppointments()` is invoked when a new `Appointment` appears in this realm.
Parameters	`osid.id.Id`	`positionId`	the `Id` of the position to monitor
Errors	NULL_ARGUMENT		`positionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAppointments
Description	Registers for notification of updated appointments. `AppointmentReceiver.changedAppointments()` is invoked when an appointment 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	registerForChangedAppointmentsForPerson
Description	Register for notifications of changed appointments for the given person `Id`. `AppointmentReceiver.changedAppointments()` is invoked when an `Appointment` for the reference in this realm is changed.
Parameters	`osid.id.Id`	`personId`	the `Id` of the person to monitor
Errors	NULL_ARGUMENT		`personId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAppointmentsForPosition
Description	Register for notifications of changed appointments for the given position `Id`. `AppointmentReceiver.changedAppointments()` is invoked when an `Appointment` for the resource is changed in this realm.
Parameters	`osid.id.Id`	`positionId`	the `Id` of the position to monitor
Errors	NULL_ARGUMENT		`positionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAppointment
Description	Registers for notification of an updated appointment. `AppointmentReceiver.changedAppointments()` is invoked when the specified appointment in this realm is changed.
Parameters	`osid.id.Id`	`appointmentId`	the `Id` of the `Appointment` to monitor
Errors	NOT_FOUND		an appointment was not found identified by the given `Id`
	NULL_ARGUMENT		`appointmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAppointments
Description	Registers for notification of deleted appointments. `AppointmentReceiver.deletedAppointments()` is invoked when an appointment 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	registerForDeletedAppointmentsForPerson
Description	Register for notifications of deleted appointments for the given person `Id`. `AppointmentReceiver.deletedAppointments()` is invoked when an `Appointment` for the reference is removed from this realm.
Parameters	`osid.id.Id`	`personId`	the `Id` of the person to monitor
Errors	NULL_ARGUMENT		`personId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAppointmentsForPosition
Description	Register for notifications of deleted appointments for the given position `Id`. `AppointmentReceiver.deletedAppointments()` is invoked when an `Appointment` for the resource is removed from this realm.
Parameters	`osid.id.Id`	`positionId`	the `Id` of the position to monitor
Errors	NULL_ARGUMENT		`positionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAppointment
Description	Registers for notification of a deleted appointment. `AppointmentReceiver.deletedAppointments()` is invoked when the specified appointment is removed from this realm.
Parameters	`osid.id.Id`	`appointmentId`	the `Id` of the `Appointment` to monitor
Errors	NOT_FOUND		an appointment was not found identified by the given `Id`
	NULL_ARGUMENT		`appointmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.