public interface RoomNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Room
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForRoomNotifications()
Tests if this user can register for
Room notifications. |
Campus |
getCampus()
Gets the
Campus associated with this session. |
Id |
getCampusId()
Gets the
Campus Id associated with this
session. |
void |
registerForChangedRoom(Id roomId)
Registers for notification of an updated room.
|
void |
registerForChangedRooms()
Registers for notification of updated rooms.
|
void |
registerForChangedRoomsByGenusType(Type roomGenusType)
Registers for notification of updated rooms of the given genus type.
|
void |
registerForChangedRoomsForBuilding(Id buildingId)
Register for notifications of chagned rooms for the given building
Id. |
void |
registerForDeletedRoom(Id roomId)
Registers for notification of a deleted room.
|
void |
registerForDeletedRooms()
Registers for notification of deleted rooms.
|
void |
registerForDeletedRoomsByGenusType(Type roomGenusType)
Registers for notification of deleted rooms of the given genus type.
|
void |
registerForDeletedRoomsForBuilding(Id buildingId)
Register for notifications of changed rooms for the given building
Id. |
void |
registerForNewRooms()
Register for notifications of new rooms.
|
void |
registerForNewRoomsByGenusType(Type roomGenusType)
Register for notifications of new rooms of the given genus type.
|
void |
registerForNewRoomsForBuilding(Id buildingId)
Register for notifications of new rooms for the given reference
Id. |
void |
useFederatedCampusView()
Federates the view for methods in this session.
|
void |
useIsolatedCampusView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCampusId()
Campus
Id
associated with this
session. Campus Id
associated with this sessionmandatory
- This method must be implemented. Campus getCampus() throws OperationFailedException, PermissionDeniedException
Campus
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForRoomNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedCampusView()
mandatory
- This method is must be implemented. void useIsolatedCampusView()
mandatory
- This method is must be implemented. void registerForNewRooms() throws OperationFailedException, PermissionDeniedException
RoomReceiver.newRooms()
is invoked when a new Room
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRoomsByGenusType(Type roomGenusType) throws OperationFailedException, PermissionDeniedException
RoomReceiver.newRooms()
is invoked when a new
Room
is created.roomGenusType
- a room genus typeNullArgumentException
- roomGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRoomsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
Id.
RoomReceiver.newRooms()
is invoked when a
new Room
is created.buildingId
- the Id
of the building to monitorNullArgumentException
- buildingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRooms() throws OperationFailedException, PermissionDeniedException
RoomReceiver.changedRooms()
is invoked when a room is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRoomsByGenusType(Type roomGenusType) throws OperationFailedException, PermissionDeniedException
RoomReceiver.changedRooms()
is invoked when a room is
changed.roomGenusType
- a room genus typeNullArgumentException
- roomGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRoomsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
Id.
RoomReceiver.changedRooms()
is
invoked when a Room
for the building is changed.buildingId
- the Id
of the building to monitorNullArgumentException
- buildingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRoom(Id roomId) throws OperationFailedException, PermissionDeniedException
RoomReceiver.changedRooms()
is invoked when the specified room
is changed.roomId
- the Id
of the Room
to
monitorNullArgumentException
- roomId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRooms() throws OperationFailedException, PermissionDeniedException
RoomReceiver.deletedRoom()
is invoked when a room is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRoomsByGenusType(Type roomGenusType) throws OperationFailedException, PermissionDeniedException
RoomReceiver.deletedRooms()
is invoked when a room is
deleted.roomGenusType
- a room genus typeNullArgumentException
- roomGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRoomsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
Id.
RoomReceiver.deletedRooms()
is
invoked when a Room
for the building is deleted.buildingId
- the Id
of the building to monitorNullArgumentException
- buildingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRoom(Id roomId) throws OperationFailedException, PermissionDeniedException
RoomReceiver.deletedRooms()
is invoked when the specified room
is deleted.roomId
- the Id
of the Room
to
monitorNullArgumentException
- roomId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.