public interface FloorNotificationSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForFloorNotifications()
Tests if this user can register for
Floor
notifications. |
Campus |
getCampus()
Gets the
Campus associated with this session. |
Id |
getCampusId()
Gets the
Campus Id associated with this
session. |
void |
registerForChangedFloor(Id floorId)
Registers for notification of an updated floor.
|
void |
registerForChangedFloors()
Registers for notification of updated floors.
|
void |
registerForChangedFloorsForBuilding(Id buildingId)
Register for notifications of changed floors for the given building
Id. |
void |
registerForDeletedFloor(Id floorId)
Registers for notification of a deleted floor.
|
void |
registerForDeletedFloors()
Registers for notification of deleted floors.
|
void |
registerForDeletedFloorsForBuilding(Id buildingId)
Register for notifications of changed floors for the given building
Id. |
void |
registerForNewFloors()
Register for notifications of new floors.
|
void |
registerForNewFloorsForBuilding(Id buildingId)
Register for notifications of new floors for the given floor
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 canRegisterForFloorNotifications()
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. 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 registerForNewFloors() throws OperationFailedException, PermissionDeniedException
FloorReceiver.newFloors()
is invoked when a new Floor
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewFloorsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
Id.
FloorReceiver.newFloors()
is invoked when a
new Floor
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 registerForChangedFloors() throws OperationFailedException, PermissionDeniedException
FloorReceiver.changedFloors()
is invoked when a floor is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedFloorsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
Id.
FloorReceiver.changedFloors()
is
invoked when a Floor
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 registerForChangedFloor(Id floorId) throws OperationFailedException, PermissionDeniedException
FloorReceiver.changedFloors()
is invoked when the specified
floor is changed.floorId
- the Id
of the Floor
to
monitorNullArgumentException
- floorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedFloors() throws OperationFailedException, PermissionDeniedException
FloorReceiver.deletedFloors()
is invoked when a floor is
deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedFloorsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
Id.
FloorReceiver.deletedFloors()
is
invoked when a Floor
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 registerForDeletedFloor(Id floorId) throws OperationFailedException, PermissionDeniedException
FloorReceiver.deletedFloors()
is invoked when the specified
floor is deleted.floorId
- the Id
of the Floor
to
monitorNullArgumentException
- floorId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.