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

This session defines methods to receive notifications on adds/changes to Floor 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 Floor 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.
MethodcanRegisterForFloorNotifications
Description

Tests if this user can register for Floor 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 floors 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.
MethodregisterForNewFloors
Description

Register for notifications of new floors. FloorReceiver.newFloors() is invoked when a new Floor is created.

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

Register for notifications of new floors for the given floor Id. FloorReceiver.newFloors() is invoked when a new Floor is created.

Parametersosid.id.IdbuildingIdthe Id of the building to monitor
ErrorsNULL_ARGUMENT buildingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedFloors
Description

Registers for notification of updated floors. FloorReceiver.changedFloors() is invoked when a floor is changed.

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

Register for notifications of changed floors for the given building Id. FloorReceiver.changedFloors() is invoked when a Floor for the building is changed.

Parametersosid.id.IdbuildingIdthe Id of the building to monitor
ErrorsNULL_ARGUMENT buildingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedFloor
Description

Registers for notification of an updated floor. FloorReceiver.changedFloors() is invoked when the specified floor is changed.

Parametersosid.id.IdfloorIdthe Id of the Floor to monitor
ErrorsNULL_ARGUMENT floorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedFloors
Description

Registers for notification of deleted floors. FloorReceiver.deletedFloors() is invoked when a floor is deleted.

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

Register for notifications of changed floors for the given building Id. FloorReceiver.deletedFloors() is invoked when a Floor for the building is deleted.

Parametersosid.id.IdbuildingIdthe Id of the building to monitor
ErrorsNULL_ARGUMENT buildingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedFloor
Description

Registers for notification of a deleted floor. FloorReceiver.deletedFloors() is invoked when the specified floor is deleted.

Parametersosid.id.IdfloorIdthe Id of the Floor to monitor
ErrorsNULL_ARGUMENT floorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.