public interface AwardNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Award
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 Award
object itself. Adding and removing conferrals result in notifications
available from the notification session for conferrals.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForAwardNotifications()
Tests if this user can register for
Award
notifications. |
Academy |
getAcademy()
Gets the
Academy associated with this session. |
Id |
getAcademyId()
Gets the
Academy Id associated with this
session. |
void |
registerForChangedAward(Id awardId)
Registers for notification of an updated award.
|
void |
registerForChangedAwards()
Registers for notification of updated awards.
|
void |
registerForDeletedAward(Id awardId)
Registers for notification of a deleted award.
|
void |
registerForDeletedAwards()
Registers for notification of deleted awards.
|
void |
registerForNewAwards()
Register for notifications of new awards.
|
void |
useFederatedAcademyView()
Federates the view for methods in this session.
|
void |
useIsolatedAcademyView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getAcademyId()
Academy
Id
associated with this
session. Academy Id
associated with this sessionmandatory
- This method must be implemented. Academy getAcademy() throws OperationFailedException, PermissionDeniedException
Academy
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForAwardNotifications()
Award
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 useFederatedAcademyView()
mandatory
- This method is must be implemented. void useIsolatedAcademyView()
mandatory
- This method is must be implemented. void registerForNewAwards() throws OperationFailedException, PermissionDeniedException
AwardReceiver.newAwards()
is invoked when a new Award
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAwards() throws OperationFailedException, PermissionDeniedException
AwardReceiver.changedAwards()
is invoked when an award is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAward(Id awardId) throws OperationFailedException, PermissionDeniedException
AwardReceiver.changedAwards()
is invoked when the specified
award is changed.awardId
- the Id
of the Award
to
monitorNullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAwards() throws OperationFailedException, PermissionDeniedException
AwardReceiver.deletedAwards()
is invoked when an award is
deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAward(Id awardId) throws OperationFailedException, PermissionDeniedException
AwardReceiver.deletedAwards()
is invoked when the specified
award is deleted.awardId
- the Id
of the Award
to
monitorNullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.