OSID - osid.room.RoomNotificationSession Service Interface Definition

Interface	osid.room.RoomNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.room.RoomManager`
Used By	`osid.room.RoomProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Rooms` . 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.
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	canRegisterForRoomNotifications
Description	Tests if this user can register for `Room` 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 entries 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	reliableRoomNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRoomNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRoomNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRoomNotification
Description	Acknowledge a room 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	registerForNewRooms
Description	Register for notifications of new rooms. `RoomReceiver.newRooms()` is invoked when a new `Room` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRoomsByGenusType
Description	Register for notifications of new rooms of the given genus type. `RoomReceiver.newRooms()` is invoked when a new `Room` is created.
Parameters	`osid.type.Type`	`roomGenusType`	a room genus type
Errors	NULL_ARGUMENT		`roomGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRoomsForBuilding
Description	Register for notifications of new rooms for the given reference `Id` . `RoomReceiver.newRooms()` is invoked when a new `Room` 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	registerForChangedRooms
Description	Registers for notification of updated rooms. `RoomReceiver.changedRooms()` is invoked when a room is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRoomsByGenusType
Description	Registers for notification of updated rooms of the given genus type. `RoomReceiver.changedRooms()` is invoked when a room is changed.
Parameters	`osid.type.Type`	`roomGenusType`	a room genus type
Errors	NULL_ARGUMENT		`roomGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRoomsForBuilding
Description	Register for notifications of chagned rooms for the given building `Id` . `RoomReceiver.changedRooms()` is invoked when a `Room` 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	registerForChangedRoom
Description	Registers for notification of an updated room. `RoomReceiver.changedRooms()` is invoked when the specified 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	registerForDeletedRooms
Description	Registers for notification of deleted rooms. `RoomReceiver.deletedRoom()` is invoked when a room is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRoomsByGenusType
Description	Registers for notification of deleted rooms of the given genus type. `RoomReceiver.deletedRooms()` is invoked when a room is deleted.
Parameters	`osid.type.Type`	`roomGenusType`	a room genus type
Errors	NULL_ARGUMENT		`roomGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRoomsForBuilding
Description	Register for notifications of changed rooms for the given building `Id` . `RoomReceiver.deletedRooms()` is invoked when a `Room` 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	registerForDeletedRoom
Description	Registers for notification of a deleted room. `RoomReceiver.deletedRooms()` is invoked when the specified 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.