OSID - osid.room.squatting.LeaseNotificationSession Service Interface Definition

Interface	osid.room.squatting.LeaseNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.room.squatting.RoomSquattingManager`
Used By	`osid.room.squatting.RoomSquattingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Leases`. 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 `Lease` object itself. Adding and removing rooms result in notifications available from the notification session for rooms.
Method	getCampusId
Description	Gets the `Campus` `Id` associated with this session.
Return	`osid.id.Id`		the `Campus Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCampus
Description	Gets the `Campus` associated with this session.
Return	`osid.room.Campus`		the campus
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForLeaseNotifications
Description	Tests if this user can register for `Lease` 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	useFederatedCampusView
Description	Federates the view for methods in this session. A federated view will include leases in campuses which are children of this campus in the campus hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCampusView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableLeaseNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeLeaseNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableLeaseNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeLeaseNotification
Description	Acknowledge a lease 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	registerForNewLeases
Description	Register for notifications of new leases. `LeaseReceiver.newLeases()` is invoked when a new `Lease` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewLeasesForRoom
Description	Register for notifications of new leases for the given room `Id`. `LeaseReceiver.newLeases()` is invoked when a new `Lease` is created.
Parameters	`osid.id.Id`	`roomId`	the `Id` of the room to monitor
Errors	NULL_ARGUMENT		`roomId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewLeasesForTenant
Description	Register for notifications of new leases for the given resource `Id`. `LeaseReceiver.newLeases()` is invoked when a new `Lease` is created.
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	registerForChangedLeases
Description	Registers for notification of updated leases. `LeaseReceiver.changedLeases()` is invoked when a lease is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLeasesForRoom
Description	Register for notifications of changed leases for the given room `Id`. `LeaseReceiver.changedLeases()` is invoked when a `Lease` for the room is changed.
Parameters	`osid.id.Id`	`roomId`	the `Id` of the room to monitor
Errors	NULL_ARGUMENT		`roomId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLeasesForTenant
Description	Register for notifications of changed leases for the given resource `Id`. `LeaseReceiver.changedLeases()` is invoked when a `Lease` for the tenant 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	registerForChangedLease
Description	Registers for notification of an updated lease. `LeaseReceiver.changedLeases()` is invoked when the specified lease is changed.
Parameters	`osid.id.Id`	`leaseId`	the `Id` of the `Lease` to monitor
Errors	NULL_ARGUMENT		`leaseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLeases
Description	Registers for notification of deleted leases. `LeaseReceiver.deletedLeases()` is invoked when a lease is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLeasesForRoom
Description	Register for notifications of changed leases for the given room `Id`. `LeaseReceiver.deletedLeases()` is invoked when a `Lease` for the room is deleted.
Parameters	`osid.id.Id`	`roomId`	the `Id` of the room to monitor
Errors	NULL_ARGUMENT		`roomId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLeasesForTenant
Description	Register for notifications of changed leases for the given resource `Id`. `LeaseReceiver.deletedLeases()` is invoked when a `Lease` for the tenant is deleted.
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	registerForDeletedLease
Description	Registers for notification of a deleted lease. `LeaseReceiver.deletedLeases()` is invoked when the specified lease is deleted.
Parameters	`osid.id.Id`	`leaseId`	the `Id` of the `Lease` to monitor
Errors	NULL_ARGUMENT		`leaseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.