public interface ObjectiveBankNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to ObjectiveBank
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 i
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeObjectiveBankNotification(Id notificationId)
Acknowledge an objective bank notification.
|
boolean |
canRegisterForObjectiveBankNotifications()
Tests if this user can register for
ObjectiveBank
notifications. |
void |
registerForChangedObjectiveBank(Id objectiveBankId)
Registers for notification of an updated objective bank.
|
void |
registerForChangedObjectiveBankHierarchy()
Registers for notification of an updated objective bank hierarchy
structure.
|
void |
registerForChangedObjectiveBankHierarchyForAncestors(Id objectiveBankId)
Registers for notification of an updated objective bank hierarchy
structure.
|
void |
registerForChangedObjectiveBankHierarchyForDescendants(Id objectiveBankId)
Registers for notification of an updated objective bank hierarchy
structure.
|
void |
registerForChangedObjectiveBanks()
Registers for notification of updated objective banks.
|
void |
registerForDeletedObjectiveBank(Id objectiveBankId)
Registers for notification of a deleted objective bank.
|
void |
registerForDeletedObjectiveBanks()
Registers for notification of deleted objective banks.
|
void |
registerForNewObjectiveBanks()
Register for notifications of new objective banks.
|
void |
reliableObjectiveBankNotifications()
Reliable notifications are desired.
|
void |
unreliableObjectiveBankNotifications()
Unreliable notifications are desired.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForObjectiveBankNotifications()
ObjectiveBank
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 reliableObjectiveBankNotifications()
acknowledgeObjectiveBankNotification()
.mandatory
- This method is must be implemented. void unreliableObjectiveBankNotifications()
mandatory
- This method is must be implemented. void acknowledgeObjectiveBankNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewObjectiveBanks() throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.newObjectiveBanks()
is invoked when a
new ObjectiveBank
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedObjectiveBanks() throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.changedObjectiveBanks()
is invoked when
an objective bank is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedObjectiveBank(Id objectiveBankId) throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.changedObjectiveBanks()
is invoked when
the specified objective bank is changed.objectiveBankId
- the Id
of the objective bank to
monitorNullArgumentException
- objectiveBankId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedObjectiveBanks() throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.deletedObjectiveBanks()
is invoked when
a calenedar is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedObjectiveBank(Id objectiveBankId) throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.deletedObjectiveBanks()
is invoked when
the specified objective bank is deleted.objectiveBankId
- the Id
of the objective bank to
monitorNullArgumentException
- objectiveBankId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedObjectiveBankHierarchy() throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.changedChildOfObjectiveBanks()
is invoked when a node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedObjectiveBankHierarchyForAncestors(Id objectiveBankId) throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.changedChildOfObjectiveBanks()
is invoked when the specified node or any of its ancestors
experiences a change in its children.objectiveBankId
- the Id
of the
ObjectiveBank
node to monitorNullArgumentException
- objectiveBankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedObjectiveBankHierarchyForDescendants(Id objectiveBankId) throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.changedChildOfObjectiveBanks()
is invoked when the specified node or any of its descendants
experiences a change in its children.objectiveBankId
- the Id
of the
ObjectiveBank
node to monitorNullArgumentException
- objectiveBankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.