public interface ResultNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Result
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 |
canRegisterForResultNotifications()
Tests if this user can register for
Result
notifications. |
Catalogue |
getCatalogue()
Gets the
Catalogue associated with this session. |
Id |
getCatalogueId()
Gets the
Catalogue Id associated with
this session. |
void |
registerForChangedResult(Id resultId)
Registers for notification of an updated result.
|
void |
registerForChangedResults()
Registers for notification of updated results.
|
void |
registerForChangedResultsForParticipant(Id participantId)
Register for notifications of changed results for the given
participant
Id. |
void |
registerForDeletedResult(Id resultId)
Registers for notification of a deleted result.
|
void |
registerForDeletedResults()
Registers for notification of deleted results.
|
void |
registerForDeletedResultsForParticipant(Id participantId)
Register for notifications of deleted results for the given
participant
Id. |
void |
registerForNewResults()
Register for notifications of new results.
|
void |
registerForNewResultsForParticipant(Id participantId)
Register for notifications of new results for the given participant
Id. |
void |
useFederatedCatalogueView()
Federates the view for methods in this session.
|
void |
useIsolatedCatalogueView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCatalogueId()
Catalogue
Id
associated with
this session. Catalogue Id
associated with this sessionmandatory
- This method must be implemented. Catalogue getCatalogue() throws OperationFailedException, PermissionDeniedException
Catalogue
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForResultNotifications()
Result
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 useFederatedCatalogueView()
mandatory
- This method is must be implemented. void useIsolatedCatalogueView()
mandatory
- This method is must be implemented. void registerForNewResults() throws OperationFailedException, PermissionDeniedException
ResultReceiver.newResults()
is invoked when a new
Result
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewResultsForParticipant(Id participantId) throws OperationFailedException, PermissionDeniedException
Id.
ResultReceiver.newResults()
is
invoked when a new Result
appears in this catalogue.participantId
- the Id
of the participant to
monitorNullArgumentException
- participantId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedResults() throws OperationFailedException, PermissionDeniedException
ResultReceiver.changedResults()
is invoked when an result in
this catalogue is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedResultsForParticipant(Id participantId) throws OperationFailedException, PermissionDeniedException
Id.
ResultReceiver.changedResults()
is invoked when an Result
for the resource is
changed in this catalogue.participantId
- the Id
of the participant to
monitorNullArgumentException
- participantId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedResult(Id resultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ResultReceiver.changedResults()
is invoked when the specified
result in this catalogue is changed.resultId
- the Id
of the Result
to
monitorNotFoundException
- an result was not found identified
by the given Id
NullArgumentException
- resultId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedResults() throws OperationFailedException, PermissionDeniedException
ResultReceiver.deletedResults()
is invoked when an result is
removed from this catalogue.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedResultsForParticipant(Id participantId) throws OperationFailedException, PermissionDeniedException
Id.
ResultReceiver.deletedResults()
is invoked when an Result
for the resource is
removed from this catalogue.participantId
- the Id
of the participant to
monitorNullArgumentException
- participantId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedResult(Id resultId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ResultReceiver.deletedResults()
is invoked when the specified
result is removed from this catalogue.resultId
- the Id
of the Result
to
monitorNotFoundException
- an result was not found identified
by the given Id
NullArgumentException
- resultId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.