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 |
---|---|
boolean |
canRegisterForObjectiveBankNotifications()
Tests if this user can register for
ObjectiveBank
notifications. |
void |
registerForChangedObjectiveBank(Id objectiveBankId)
Registers for notification of an updated objective bank.
|
void |
registerForChangedObjectiveBanks()
Registers for notification of updated objective banks.
|
void |
registerForDeletedObjectiveBank(Id objectiveBankId)
Registers for notification of a deleted objective bank.
|
void |
registerForDeletedObjectiveBankAncestors(Id objectiveBankId)
Registers for notification if an ancestor is removed from the
specified objective bank in the objective bank hierarchy.
|
void |
registerForDeletedObjectiveBankDescendants(Id objectiveBankId)
Registers for notification if a descendant is removed from fthe
specified objective bank in the objective bank hierarchy.
|
void |
registerForDeletedObjectiveBanks()
Registers for notification of deleted objective banks.
|
void |
registerForNewObjectiveBankAncestors(Id objectiveBankId)
Registers for notification if an ancestor is added to the specified
objective bank in the objective bank hierarchy.
|
void |
registerForNewObjectiveBankDescendants(Id objectiveBankId)
Registers for notification if a descendant is added to the specified
objective bank in the objective bank hierarchy.
|
void |
registerForNewObjectiveBanks()
Register for notifications of new objective banks.
|
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 registerForNewObjectiveBanks() throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.newObjectiveBank()
is invoked when a new
ObjectiveBank
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewObjectiveBankAncestors(Id objectiveBankId) throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.newObjectiveBankAncestor()
is invoked
when the specified objective bank experiences an addition in ancestry.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 registerForNewObjectiveBankDescendants(Id objectiveBankId) throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.newObjectiveBankDescendant()
is invoked
when the specified objective bank experiences an addition in
descendants.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 registerForChangedObjectiveBanks() throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.changedObjectiveBank()
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.changedObjectiveBank()
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.deletedObjectiveBank()
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.deletedObjectiveBank()
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 registerForDeletedObjectiveBankAncestors(Id objectiveBankId) throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.deletedObjectiveBankAncestor()
is
invoked when the specified objective bank experiences a removal of an
ancestor.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 registerForDeletedObjectiveBankDescendants(Id objectiveBankId) throws OperationFailedException, PermissionDeniedException
ObjectiveBankReceiver.deletedObjectiveBankDescednant()
is
invoked when the specified objective bank experiences a removal of one
of its descendants.objectiveBankId
- the Id
of the objective bank to
monitorNullArgumentException
- objectiveBankId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.