OSID - osid.resourcing.AvailabilityNotificationSession Service Interface Definition

Interface	osid.resourcing.AvailabilityNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.resourcing.ResourcingManager`
Used By	`osid.resourcing.ResourcingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Availability` objects in this `Foundry`. 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 `AvailabilityLookupSession`.
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForAvailabilityNotifications
Description	Tests if this user can register for `Availability` 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	useFederatedFoundryView
Description	Federates the view for methods in this session. A federated view will include availabilities in foundries which are children of this foundry in the foundry hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFoundryView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this foundry only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableAvailabilityNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAvailabilityNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAvailabilityNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAvailabilityNotification
Description	Acknowledge an availability 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	registerForNewAvailabilities
Description	Register for notifications of new availabilities. `AvailabilityReceiver.newAvailabilities()` is invoked when a new `Availability` appears in this foundry.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewAvailabilitiesForResource
Description	Register for notifications of new availabilities for the given resource. `AvailabilityReceiver.newAvailabilities()` is invoked when a new `Availability` appears in this foundry.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewAvailabilitiesForJob
Description	Register for notifications of new availabilities for the given job. `AvailabilityReceiver.newAvailabilities()` is invoked when a new `Availability` appears in this foundry.
Parameters	`osid.id.Id`	`jobId`	the `Id` of the job to monitor
Errors	NULL_ARGUMENT		`jobId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAvailabilities
Description	Registers for notification of updated availabilities. `AvailabilityReceiver.changedAvailabilities()` is invoked when an availability in this foundry is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAvailabilitiesForResource
Description	Registers for notification of updated availabilities for the given resource. `AvailabilityReceiver.changedAvailabilities()` is invoked when an availability in this foundry is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAvailabilitiesForJob
Description	Registers for notification of updated availabilities for the given job. `AvailabilityReceiver.changedAvailability()` is invoked when an availability in this foundry is changed.
Parameters	`osid.id.Id`	`jobId`	the `Id` of the job to monitor
Errors	NULL_ARGUMENT		`jobId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAvailability
Description	Registers for notification of an updated availability. `AvailabilityReceiver.changedAvailabilities()` is invoked when the specified availability in this foundry is changed.
Parameters	`osid.id.Id`	`availabilityId`	the `Id` of the `Availability` to monitor
Errors	NULL_ARGUMENT		`availabilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAvailabilities
Description	Registers for notification of deleted availabilities. `AvailabilityReceiver.deletedAvailabilities()` is invoked when an availability is deleted or removed from this foundry.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAvailabilitiesForResource
Description	Registers for notification of deleted availabilities for the given resource. `AvailabilityReceiver.deletedAvailabilities()` is invoked when an availability is deleted or removed from this foundry.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAvailabilitiesForJob
Description	Registers for notification of deleted availabilities for the given job. `AvailabilityReceiver.deletedAvailabilities()` is invoked when an availability is deleted or removed from this foundry.
Parameters	`osid.id.Id`	`jobId`	the `Id` of the job to monitor
Errors	NULL_ARGUMENT		`jobId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAvailability
Description	Registers for notification of a deleted availability. `AvailabilityReceiver.deletedAvailabilities()` is invoked when the specified availability is deleted or removed from this foundry.
Parameters	`osid.id.Id`	`availabilityId`	the `Id` of the `Availability` to monitor
Errors	NULL_ARGUMENT		`availabilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.