public interface ConferralNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Conferral
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 |
---|---|
boolean |
canRegisterForConferralNotifications()
Tests if this user can register for
Conferral
notifications. |
Academy |
getAcademy()
Gets the
Academy associated with this session. |
Id |
getAcademyId()
Gets the
Academy Id associated with this
session. |
void |
registerForChangedConferral(Id conferralId)
Registers for notification of an updated conferral.
|
void |
registerForChangedConferrals()
Registers for notification of updated conferrals.
|
void |
registerForChangedConferralsByConvocation(Id convocationId)
Register for notifications of changed conferrals for the given award
Id. |
void |
registerForChangedConferralsForAward(Id awardId)
Register for notifications of changed conferrals for the given award
Id. |
void |
registerForChangedConferralsForRecipient(Id resourceId)
Register for notifications of changed conferrals for the given
recipient
Id. |
void |
registerForDeletedConferral(Id conferralId)
Registers for notification of a deleted conferral.
|
void |
registerForDeletedConferrals()
Registers for notification of deleted conferrals.
|
void |
registerForDeletedConferralsByConvocation(Id convocationId)
Register for notifications of deleted conferrals for the given
convocation
Id. |
void |
registerForDeletedConferralsForAward(Id awardId)
Register for notifications of deleted conferrals for the given award
Id. |
void |
registerForDeletedConferralsForRecipient(Id resourceId)
Register for notifications of deleted conferrals for the given
recipient
Id. |
void |
registerForNewConferrals()
Register for notifications of new conferrals.
|
void |
registerForNewConferralsByConvocation(Id convocationId)
Register for notifications of new conferrals for the given convocation
Id. |
void |
registerForNewConferralsForAward(Id awardId)
Register for notifications of new conferrals for the given reference
Id. |
void |
registerForNewConferralsForRecipient(Id resourceId)
Register for notifications of new conferrals for the given recipient
Id. |
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 canRegisterForConferralNotifications()
Conferral
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 registerForNewConferrals() throws OperationFailedException, PermissionDeniedException
ConferralReceiver.newConferrals()
is invoked when a new
Conferral
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewConferralsForRecipient(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
ConferralReceiver.newConferrals()
is
invoked when a new Conferral
is created.resourceId
- the Id
of the recipient to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewConferralsForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
Id.
ConferralReceiver.newConferrals()
is
invoked when a new Conferral
is created.awardId
- the Id
of the award to monitorNullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewConferralsByConvocation(Id convocationId) throws OperationFailedException, PermissionDeniedException
Id.
ConferralReceiver.newConferrals()
is
invoked when a new Conferral
is created.convocationId
- the Id
of the convocation to
monitorNullArgumentException
- convocationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedConferrals() throws OperationFailedException, PermissionDeniedException
ConferralReceiver.changedConferrals()
is invoked when a
conferral is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedConferralsForRecipient(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
ConferralReceiver.changedConferrals()
is invoked when a
Conferral
for the recipient is changed.resourceId
- the Id
of the resource to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedConferralsForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
Id.
ConferralReceiver.changedConferrals()
is invoked when a Conferral
for the 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 registerForChangedConferralsByConvocation(Id convocationId) throws OperationFailedException, PermissionDeniedException
Id.
ConferralReceiver.changedConferrals()
is invoked when a Conferral
for the convocation
is changed.convocationId
- the Id
of the convocation to
monitorNullArgumentException
- convocationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedConferral(Id conferralId) throws OperationFailedException, PermissionDeniedException
ConferralReceiver.changedConferrals()
is invoked when the
specified conferral is changed.conferralId
- the Id
of the Conferral
to monitorNullArgumentException
- conferralId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedConferrals() throws OperationFailedException, PermissionDeniedException
ConferralReceiver.deletedConferrals()
is invoked when a
conferral is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedConferralsForRecipient(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
ConferralReceiver.deletedConferrals()
is invoked when a
Conferral
for the recipient is deleted.resourceId
- the Id
of the recipient to monitorNullArgumentException
- recipientId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedConferralsForAward(Id awardId) throws OperationFailedException, PermissionDeniedException
Id.
ConferralReceiver.deletedConferrals()
is invoked when a Conferral
for the 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. void registerForDeletedConferralsByConvocation(Id convocationId) throws OperationFailedException, PermissionDeniedException
Id.
ConferralReceiver.deletedConferrals()
is invoked when a
Conferral
for the convocation is deleted.convocationId
- the Id
of the convocation to
monitorNullArgumentException
- convocationId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedConferral(Id conferralId) throws OperationFailedException, PermissionDeniedException
ConferralReceiver.deletedConferrals()
is invoked when the
specified conferral is deleted.conferralId
- the Id
of the Conferral
to monitorNullArgumentException
- conferralId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.