public interface ConvocationNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Convocation
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 |
canRegisterForConvocationNotifications()
Tests if this user can register for
Convocation
notifications. |
Academy |
getAcademy()
Gets the
Academy associated with this session. |
Id |
getAcademyId()
Gets the
Academy Id associated with this
session. |
void |
registerForChangedConvocation(Id convocationId)
Registers for notification of an updated convocation.
|
void |
registerForChangedConvocations()
Registers for notification of updated convocations.
|
void |
registerForDeletedConvocation(Id convocationId)
Registers for notification of a deleted convocation.
|
void |
registerForDeletedConvocations()
Registers for notification of deleted convocations.
|
void |
registerForNewConvocations()
Register for notifications of new convocations.
|
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 canRegisterForConvocationNotifications()
Convocation
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 registerForNewConvocations() throws OperationFailedException, PermissionDeniedException
ConvocationReceiver.newConvocations()
is invoked when a new
Convocation
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedConvocations() throws OperationFailedException, PermissionDeniedException
ConvocationReceiver.changedConvocations()
is invoked when a
convocation is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedConvocation(Id convocationId) throws OperationFailedException, PermissionDeniedException
ConvocationReceiver.changedConvocations()
is invoked when the
specified 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 registerForDeletedConvocations() throws OperationFailedException, PermissionDeniedException
ConvocationReceiver.deletedConvocations()
is invoked when a
convocation is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedConvocation(Id convocationId) throws OperationFailedException, PermissionDeniedException
ConvocationReceiver.deletedConvocations()
is invoked when the
specified 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.