Interface | osid.offering.ResultNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | getCatalogueId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Catalogue Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCatalogue | ||
Description |
Gets the | ||
Return | osid.offering.Catalogue | the catalogue | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForResultNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedCatalogueView | ||
Description |
Federates the view for methods in this session. A federated view will include notifications for resultss in catalogues which are children of this catalogue in the catalogue hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCatalogueView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this catalogue only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewResults | ||
Description |
Register for notifications of new results. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewResultsForParticipant | ||
Description |
Register for notifications of new results for the given
participant | ||
Parameters | osid.id.Id | participantId | the Id of the participant to monitor |
Errors | NULL_ARGUMENT | participantId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedResults | ||
Description |
Registers for notification of updated results. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedResultsForParticipant | ||
Description |
Register for notifications of changed results for the
given participant | ||
Parameters | osid.id.Id | participantId | the Id of the participant to monitor |
Errors | NULL_ARGUMENT | participantId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedResult | ||
Description |
Registers for notification of an updated result. | ||
Parameters | osid.id.Id | resultId | the Id of the Result to monitor |
Errors | NOT_FOUND | an result was not found identified by the given Id | |
NULL_ARGUMENT | resultId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedResults | ||
Description |
Registers for notification of deleted results. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedResultsForParticipant | ||
Description |
Register for notifications of deleted results for the
given participant | ||
Parameters | osid.id.Id | participantId | the Id of the participant to monitor |
Errors | NULL_ARGUMENT | participantId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedResult | ||
Description |
Registers for notification of a deleted result. | ||
Parameters | osid.id.Id | resultId | the Id of the Result to monitor |
Errors | NOT_FOUND | an result was not found identified by the given Id | |
NULL_ARGUMENT | resultId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |