public interface RenovationNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Renovation
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 Renovation
object itself. Adding and removing rooms result in notifications
available from the notification session for rooms.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForRenovationNotifications()
Tests if this user can register for
Renovation
notifications. |
Campus |
getCampus()
Gets the
Campus associated with this session. |
Id |
getCampusId()
Gets the
Campus Id associated with this
session. |
void |
registerForChangedRenovation(Id renovationId)
Registers for notification of an updated renovation.
|
void |
registerForChangedRenovations()
Registers for notification of updated renovations.
|
void |
registerForChangedRenovationsByRoom(Id roomId)
Register for notifications of changed renovations for the given room
Id. |
void |
registerForDeletedRenovation(Id renovationId)
Registers for notification of a deleted renovation.
|
void |
registerForDeletedRenovations()
Registers for notification of deleted renovations.
|
void |
registerForDeletedRenovationsByRoom(Id roomId)
Register for notifications of changed renovations for the given room
Id. |
void |
registerForNewRenovations()
Register for notifications of new renovations.
|
void |
registerForNewRenovationsByRoom(Id roomId)
Register for notifications of new renovations for the given room
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 canRegisterForRenovationNotifications()
Renovation
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 registerForNewRenovations() throws OperationFailedException, PermissionDeniedException
RenovationReceiver.newRenovation()
is invoked when a new
Renovation
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRenovationsByRoom(Id roomId) throws OperationFailedException, PermissionDeniedException
Id.
RenovationReceiver.newRenovation()
is invoked when a new Renovation
is created.roomId
- the Id
of the room to monitorNullArgumentException
- roomId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRenovations() throws OperationFailedException, PermissionDeniedException
RenovationReceiver.changedRenovation()
is invoked when a
renovation is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRenovationsByRoom(Id roomId) throws OperationFailedException, PermissionDeniedException
Id.
RenovationReceiver.changedRenovation()
is invoked when a Renovation
for the 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 registerForChangedRenovation(Id renovationId) throws OperationFailedException, PermissionDeniedException
RenovationReceiver.changedRenovation()
is invoked when the
specified renovation is changed.renovationId
- the Id
of the Renovation
to monitorNullArgumentException
- renovationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRenovations() throws OperationFailedException, PermissionDeniedException
RenovationReceiver.deletedRenovation()
is invoked when a
renovation is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRenovationsByRoom(Id roomId) throws OperationFailedException, PermissionDeniedException
Id.
RenovationReceiver.deletedRenovation()
is invoked when a Renovation
for the 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. void registerForDeletedRenovation(Id renovationId) throws OperationFailedException, PermissionDeniedException
RenovationReceiver.deletedRenovation()
is invoked when the
specified renovation is deleted.renovationId
- the Id
of the Renovation
to monitorNullArgumentException
- renovationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.