public interface DeedNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Deed
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 Deed
object itself. Adding and removing rooms result in notifications available
from the notification session for rooms.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForDeedNotifications()
Tests if this user can register for
Deed notifications. |
Campus |
getCampus()
Gets the
Campus associated with this session. |
Id |
getCampusId()
Gets the
Campus Id associated with this
session. |
void |
registerForChangedDeed(Id deedId)
Registers for notification of an updated deed.
|
void |
registerForChangedDeeds()
Registers for notification of updated deeds.
|
void |
registerForChangedDeedsForBuilding(Id buildingId)
Registers for notification of a updated deedsfor a building.
|
void |
registerForChangedDeedsForOwner(Id resourceId)
Registers for notification of updated deeds for an owner.
|
void |
registerForDeletedDeed(Id deedId)
Registers for notification of a deleted deed.
|
void |
registerForDeletedDeeds()
Registers for notification of deleted deeds.
|
void |
registerForDeletedDeedsForBuilding(Id buildingId)
Registers for notification of a deleted deed for a building.
|
void |
registerForDeletedDeedsForOwner(Id resourceId)
Registers for notification of a deleted deed for an owner.
|
void |
registerForNewDeeds()
Register for notifications of new deeds.
|
void |
registerForNewDeedsForBuilding(Id buildingId)
Registers for notification of new deeds for a building.
|
void |
registerForNewDeedsForOwner(Id resourceId)
Registers for notification of new deeds for an owner.
|
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 canRegisterForDeedNotifications()
Deed
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 registerForNewDeeds() throws OperationFailedException, PermissionDeniedException
DeedReceiver.newDeeds()
is invoked when a new Deed
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewDeedsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
DeedReceiver.newDeeds()
is invoked when a deed for the
building 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 registerForNewDeedsForOwner(Id resourceId) throws OperationFailedException, PermissionDeniedException
DeedReceiver.NewDeeds()
is invoked when a deed for the owner
is created.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedDeeds() throws OperationFailedException, PermissionDeniedException
DeedReceiver.changedDeeds()
is invoked when a deed is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedDeedsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
DeedReceiver.changedDeeds()
is invoked when a deed 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 registerForChangedDeedsForOwner(Id resourceId) throws OperationFailedException, PermissionDeniedException
DeedReceiver.changedDeeds()
is invoked when a deed for the
owner is changed.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedDeed(Id deedId) throws OperationFailedException, PermissionDeniedException
DeedReceiver.changedDeeds()
is invoked when the specified deed
is changed.deedId
- the Id
of the Deed
to
monitorNullArgumentException
- deedId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedDeeds() throws OperationFailedException, PermissionDeniedException
DeedReceiver.deletedDeeds()
is invoked when a deed is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedDeedsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
DeedReceiver.deletedDeeds()
is invoked when a deed 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 registerForDeletedDeedsForOwner(Id resourceId) throws OperationFailedException, PermissionDeniedException
DeedReceiver.deletedDeeds()
is invoked when a deed for the
owner is deleted.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedDeed(Id deedId) throws OperationFailedException, PermissionDeniedException
DeedReceiver.deletedDeeds()
is invoked when the specified deed
is deleted.deedId
- the Id
of the Deed
to
monitorNullArgumentException
- deedId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.