OSID Logo
OSID Specifications
room squatting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.squatting.LeaseNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Lease 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 Lease object itself. Adding and removing rooms result in notifications available from the notification session for rooms.

MethodgetCampusId
Description

Gets the Campus Id associated with this session.

Returnosid.id.Idthe Campus Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCampus
Description

Gets the Campus associated with this session.

Returnosid.room.Campusthe campus
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForLeaseNotifications
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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCampusView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCampusView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewLeases
Description

Register for notifications of new leases. LeaseReceiver.newLeases() is invoked when a new Lease is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewLeasesForRoom
Description

Register for notifications of new leases for the given room Id. LeaseReceiver.newLeases() is invoked when a new Lease is created.

Parametersosid.id.IdroomIdthe Id of the room to monitor
ErrorsNULL_ARGUMENT roomId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewLeasesForTenant
Description

Register for notifications of new leases for the given resource Id. LeaseReceiver.newLeases() is invoked when a new Lease is created.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedLeases
Description

Registers for notification of updated leases. LeaseReceiver.changedLeases() is invoked when a lease is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedLeasesForRoom
Description

Register for notifications of changed leases for the given room Id. LeaseReceiver.changedLeases() is invoked when a Lease for the room is changed.

Parametersosid.id.IdroomIdthe Id of the room to monitor
ErrorsNULL_ARGUMENT roomId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedLeasesForTenant
Description

Register for notifications of changed leases for the given resource Id. LeaseReceiver.changedLeases() is invoked when a Lease for the tenant is changed.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedLease
Description

Registers for notification of an updated lease. LeaseReceiver.changedLeases() is invoked when the specified lease is changed.

Parametersosid.id.IdleaseIdthe Id of the Lease to monitor
ErrorsNULL_ARGUMENT leaseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedLeases
Description

Registers for notification of deleted leases. LeaseReceiver.deletedLeases() is invoked when a lease is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedLeasesForRoom
Description

Register for notifications of changed leases for the given room Id. LeaseReceiver.deletedLeases() is invoked when a Lease for the room is deleted.

Parametersosid.id.IdroomIdthe Id of the room to monitor
ErrorsNULL_ARGUMENT roomId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedLeasesForTenant
Description

Register for notifications of changed leases for the given resource Id. LeaseReceiver.deletedLeases() is invoked when a Lease for the tenant is deleted.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedLease
Description

Registers for notification of a deleted lease. LeaseReceiver.deletedLeases() is invoked when the specified lease is deleted.

Parametersosid.id.IdleaseIdthe Id of the Lease to monitor
ErrorsNULL_ARGUMENT leaseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.