public interface OublietteNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Oubliette
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 |
---|---|
void |
acknowledgeOublietteNotification(Id notificationId)
Acknowledge a oubliette notification.
|
boolean |
canRegisterForOublietteNotifications()
Tests if this user can register for
Oubliette
notifications. |
void |
registerForChangedOubliette(Id oublietteId)
Registers for notification of an updated oubliette.
|
void |
registerForChangedOublietteHierarchy()
Registers for notification of an updated oubliette hierarchy
structure.
|
void |
registerForChangedOublietteHierarchyForAncestors(Id oublietteId)
Oubliette
Receiver.changedChildOfOubliettes() is
invoked when the specified node or any of its ancestors experiences a
change in its children. |
void |
registerForChangedOublietteHierarchyForDescendants(Id oublietteId)
Registers for notification of an updated oubliette hierarchy
structure.
|
void |
registerForChangedOubliettes()
Registers for notification of updated oubliettes.
|
void |
registerForDeletedOubliette(Id oublietteId)
Registers for notification of a deleted oubliette.
|
void |
registerForDeletedOubliettes()
Registers for notification of deletedoOubliettes.
|
void |
registerForNewOubliettes()
Register for notifications of new oubliettes.
|
void |
reliableOublietteNotifications()
Reliable notifications are desired.
|
void |
unreliableOublietteNotifications()
Unreliable notifications are desired.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForOublietteNotifications()
Oubliette
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 reliableOublietteNotifications()
acknowledgeOublietteNotification()
.mandatory
- This method is must be implemented. void unreliableOublietteNotifications()
mandatory
- This method is must be implemented. void acknowledgeOublietteNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewOubliettes() throws OperationFailedException, PermissionDeniedException
OublietteReceiver.newOubliettes()
is invoked when a new
Oubliette
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOubliettes() throws OperationFailedException, PermissionDeniedException
OublietteReceiver.changedOubliettes()
is invoked when an
oubliette is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OublietteReceiver.changedOubliettes()
is invoked when the
specified oubliette is changed.oublietteId
- the Id of the Oubliette
to monitorNotFoundException
- an oubliette was not found
identified by the given Id
NullArgumentException
- oublietteId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedOubliettes() throws OperationFailedException, PermissionDeniedException
OublietteReceiver.deletedOubliettes()
is invoked when an
oubliette is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedOubliette(Id oublietteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
OublietteReceiver.deletedOubliettes()
is invoked when the
specified oubliette is deleted.oublietteId
- the Id
of the Oubliette
to monitorNotFoundException
- an oubliette was not found
identified by the given Id
NullArgumentException
- oublietteId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOublietteHierarchy() throws OperationFailedException, PermissionDeniedException
OublietteReceiver.changedChildOfOubliettes()
is invoked when a node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOublietteHierarchyForAncestors(Id oublietteId) throws OperationFailedException, PermissionDeniedException
Receiver.changedChildOfOubliettes()
is
invoked when the specified node or any of its ancestors experiences a
change in its children.oublietteId
- the Id
of the Oubliette
node to monitorNullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOublietteHierarchyForDescendants(Id oublietteId) throws OperationFailedException, PermissionDeniedException
OublietteReceiver.changedChildOfOubliettes()
is invoked when the specified node or any of its descendants
experiences a change in its children.oublietteId
- the Id
of the Oubliette
node to monitorNullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.