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

This session defines methods to receive notifications on adds/changes to Participant 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.
MethodcanRegisterForParticipantNotifications
Description

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

Register for notifications of new participants. ParticipantReceiver.newParticipants() is invoked when a new Participant is appears in this catalogue.

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

Register for notifications of new participants for an offering. ParticipantReceiver.newParticipants() is invoked when a new Participant appears in this catalogue.

Parametersosid.id.IdofferingIdan offering to monitor
ErrorsNULL_ARGUMENT offeringId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewParticipantsForResource
Description

Register for notifications of new participants for a resource. ParticipantReceiver.newParticipants() is invoked when a new Participant appears in this catalogue.

Parametersosid.id.IdresourceIda resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedParticipants
Description

Registers for notification of updated participants. ParticipantReceiver.changedParticipants() is invoked when a participant in this catalogue is changed.

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

Register for notifications of changed participants for the given offering. ParticipantReceiver.changedParticipants() is invoked when a Participant for the offering in this catalogue is changed.

Parametersosid.id.IdofferingIdan offering to monitor
ErrorsNULL_ARGUMENT offeringId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedParticipantsForResource
Description

Register for notifications of changed participants for the given resource. ParticipantReceiver.changedParticipants() is invoked when a Participant for the offering in this catalogue is changed.

Parametersosid.id.IdresourceIda resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedParticipant
Description

Registers for notification of an updated participant. ParticipantReceiver.changedParticipants() is invoked when the specified participant in this catalogue is changed.

Parametersosid.id.IdparticipantIdthe Id of the Participant to monitor
ErrorsNOT_FOUNDa participant was not found identified by the given Id
NULL_ARGUMENT participantId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedParticipants
Description

Registers for notification of deleted participants. ParticipantReceiver.deletedParticipants() is invoked when a participant is removed from this catalogue.

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

Register for notifications of deleted participants for the given offering. ParticipantReceiver.deletedParticipants() is invoked when a Participant for the offering is removed from this catalogue.

Parametersosid.id.IdofferingIdan offering to monitor
ErrorsNULL_ARGUMENT offeringId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedParticipantsForResource
Description

Register for notifications of deleted participants for the given resource. ParticipantReceiver.deletedParticipants() is invoked when a Participant for the offering is removed from this catalogue.

Parametersosid.id.IdresourceIda resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedParticipant
Description

Registers for notification of a deleted participants. ParticipantReceiver.deletedParticipants() is invoked when the specified participant is removed from this catalogue.

Parametersosid.id.IdparticipantIdthe Id of the Participant to monitor
ErrorsNOT_FOUNDa participant was not found identified by the given Id
NULL_ARGUMENT participantId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.