OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.ResultNotificationSession
Implementsosid.OsidSession
Description

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.

MethodgetCatalogueId
Description

Gets the Catalogue Id associated with this session.

Returnosid.id.Idthe Catalogue Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCatalogue
Description

Gets the Catalogue associated with this session.

Returnosid.offering.Cataloguethe catalogue
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForResultNotifications
Description

Tests if this user can register for 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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCatalogueView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCatalogueView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this catalogue only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewResults
Description

Register for notifications of new results. ResultReceiver.newResults() is invoked when a new Result is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewResultsForParticipant
Description

Register for notifications of new results for the given participant Id. ResultReceiver.newResults() is invoked when a new Result appears in this catalogue.

Parametersosid.id.IdparticipantIdthe Id of the participant to monitor
ErrorsNULL_ARGUMENT participantId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedResults
Description

Registers for notification of updated results. ResultReceiver.changedResults() is invoked when an result in this catalogue is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedResultsForParticipant
Description

Register for notifications of changed results for the given participant Id. ResultReceiver.changedResults() is invoked when an Result for the resource is changed in this catalogue.

Parametersosid.id.IdparticipantIdthe Id of the participant to monitor
ErrorsNULL_ARGUMENT participantId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedResult
Description

Registers for notification of an updated result. ResultReceiver.changedResults() is invoked when the specified result in this catalogue is changed.

Parametersosid.id.IdresultIdthe Id of the Result to monitor
ErrorsNOT_FOUNDan result was not found identified by the given Id
NULL_ARGUMENT resultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedResults
Description

Registers for notification of deleted results. ResultReceiver.deletedResults() is invoked when an result is removed from this catalogue.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedResultsForParticipant
Description

Register for notifications of deleted results for the given participant Id. ResultReceiver.deletedResults() is invoked when an Result for the resource is removed from this catalogue.

Parametersosid.id.IdparticipantIdthe Id of the participant to monitor
ErrorsNULL_ARGUMENT participantId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedResult
Description

Registers for notification of a deleted result. ResultReceiver.deletedResults() is invoked when the specified result is removed from this catalogue.

Parametersosid.id.IdresultIdthe Id of the Result to monitor
ErrorsNOT_FOUNDan result was not found identified by the given Id
NULL_ARGUMENT resultId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.