Interface | osid.room.squatting.LeaseNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the | ||
Method | getCampusId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Campus Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCampus | ||
Description |
Gets the | ||
Return | osid.room.Campus | the campus | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForLeaseNotifications | ||
Description |
Tests if this user can register for | ||
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 | registerForNewLeases | ||
Description |
Register for notifications of new leases. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewLeasesForRoom | ||
Description |
Register for notifications of new leases for the given
room | ||
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 | ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedLeasesForRoom | ||
Description |
Register for notifications of changed leases for the
given room | ||
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 | ||
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. | ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedLeasesForRoom | ||
Description |
Register for notifications of changed leases for the
given room | ||
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 | ||
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. | ||
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. |