OSID - osid.room.FloorNotificationSession Service Interface Definition

Interface	osid.room.FloorNotificationSession
Implements	`osid.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.
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	canRegisterForFloorNotifications
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.
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 floors 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	registerForNewFloors
Description	Register for notifications of new floors. `FloorReceiver.newFloors()` is invoked when a new `Floor` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewFloorsForBuilding
Description	Register for notifications of new floors for the given floor `Id.` `FloorReceiver.newFloors()` is invoked when a new `Floor` is created.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of the building to monitor
Errors	NULL_ARGUMENT		`buildingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFloors
Description	Registers for notification of updated floors. `FloorReceiver.changedFloors()` is invoked when a floor is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFloorsForBuilding
Description	Register for notifications of changed floors for the given building `Id.` `FloorReceiver.changedFloors()` is invoked when a `Floor` for the building is changed.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of the building to monitor
Errors	NULL_ARGUMENT		`buildingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedFloor
Description	Registers for notification of an updated floor. `FloorReceiver.changedFloors()` is invoked when the specified floor is changed.
Parameters	`osid.id.Id`	`floorId`	the `Id` of the `Floor` to monitor
Errors	NULL_ARGUMENT		`floorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedFloors
Description	Registers for notification of deleted floors. `FloorReceiver.deletedFloors()` is invoked when a floor is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedFloorsForBuilding
Description	Register for notifications of changed floors for the given building `Id.` `FloorReceiver.deletedFloors()` is invoked when a `Floor` for the building is deleted.
Parameters	`osid.id.Id`	`buildingId`	the `Id` of the building to monitor
Errors	NULL_ARGUMENT		`buildingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedFloor
Description	Registers for notification of a deleted floor. `FloorReceiver.deletedFloors()` is invoked when the specified floor is deleted.
Parameters	`osid.id.Id`	`floorId`	the `Id` of the `Floor` to monitor
Errors	NULL_ARGUMENT		`floorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.