public interface AcademyNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Academy
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 Academy
object itself. Adding and removing conferrals result in notifications
available from the notification session for conferrals.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForAcademyNotifications()
Tests if this user can register for
Academy
notifications. |
void |
registerForChangedAcademies()
Registers for notification of updated academies.
|
void |
registerForChangedAcademy(Id academyId)
Registers for notification of an updated academy.
|
void |
registerForDeletedAcademies()
Registers for notification of deleted academies.
|
void |
registerForDeletedAcademy(Id academyId)
Registers for notification of a deleted academy.
|
void |
registerForDeletedAcademyAncestors(Id academyId)
Registers for notification of an updated hierarchy structure that
removes an ancestor of the specified academy
AcademyReceiver.deletedAncestor() is invoked when the
specified academy node loses an ancestor. |
void |
registerForDeletedAcademyDescendants(Id academyId)
Registers for notification of an updated hierarchy structure that
removes a descendant of the specified academy.
|
void |
registerForNewAcademies()
Register for notifications of new academies.
|
void |
registerForNewAcademyAncestors(Id academyId)
Registers for notification of an updated hierarchy structure that
introduces a new ancestor of the specified academy.
|
void |
registerForNewAcademyDescendants(Id academyId)
Registers for notification of an updated hierarchy structure that
introduces a new descendant of the specified academy.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForAcademyNotifications()
Academy
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 registerForNewAcademies() throws OperationFailedException, PermissionDeniedException
AcademyReceiver.newAcademies()
is invoked when a new
Academy
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAcademyAncestors(Id academyId) throws OperationFailedException, PermissionDeniedException
AcademyReceiver.newAncestorAcademy()
is invoked when the
specified academy node gets a new ancestor.academyId
- the Id
of the Academy
node to monitorNullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAcademyDescendants(Id academyId) throws OperationFailedException, PermissionDeniedException
AcademyReceiver.newDescendantAcademy()
is invoked when the
specified academy node gets a new descendant.academyId
- the Id
of the Academy
node to monitorNullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAcademies() throws OperationFailedException, PermissionDeniedException
AcademyReceiver.changedAcademies()
is invoked when an academy
is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAcademy(Id academyId) throws OperationFailedException, PermissionDeniedException
AcademyReceiver.changedAcademies()
is invoked when the
specified academy is changed.academyId
- the Id
of the Academy
to monitorNullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAcademies() throws OperationFailedException, PermissionDeniedException
AcademyReceiver.deletedAcademies()
is invoked when an academy
is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAcademy(Id academyId) throws OperationFailedException, PermissionDeniedException
AcademyReceiver.deletedAcademies()
is invoked when the
specified academy is deleted.academyId
- the Id
of the Academy
to monitorNullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAcademyAncestors(Id academyId) throws OperationFailedException, PermissionDeniedException
AcademyReceiver.deletedAncestor()
is invoked when the
specified academy node loses an ancestor.academyId
- the Id
of the Academy
to monitorNullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAcademyDescendants(Id academyId) throws OperationFailedException, PermissionDeniedException
AcademyReceiver.deletedDescendant()
is invoked when the
specified academy node loses a descendant.academyId
- the Id
of the Academy
to monitorNullArgumentException
- academyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.