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

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

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

Register for notifications of new offerings. OfferingReceiver.newOfferings() is invoked when a new Offering is created.

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

Registers for notification of new offerings for the given canonical unit. OfferingReceiver.newOfferings() is invoked when an offering appears in this catalogue.

Parametersosid.id.IdcanonicalUnitIdthe Id of the CanonicalUnit to monitor
ErrorsNULL_ARGUMENT canonicalUnitId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewOfferingsForTimePeriod
Description

Registers for notification of new offerings for the given time period. OfferingReceiver.newOfferings() is invoked when an offering appears in this catalogue.

Parametersosid.id.IdtimePeriodIdthe Id of the TimePeriod to monitor
ErrorsNULL_ARGUMENT timePeriodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOfferings
Description

Registers for notification of updated offerings. OfferingReceiver.changedOfferings() is invoked when an offering in this catalogue is changed.

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

Registers for notification of updated offerings for the given canonical unit. OfferingReceiver.changedOfferings() is invoked when an offering in this catalogue is updated.

Parametersosid.id.IdcanonicalUnitIdthe Id of the CanonicalUnit to monitor
ErrorsNULL_ARGUMENT canonicalUnitId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOfferingsForTimePeriod
Description

Registers for notification of updated offerings for the given time period. OfferingReceiver.changedOfferings() is invoked when an offering in this catalogue is updated.

Parametersosid.id.IdtimePeriodIdthe Id of the TimePeriod to monitor
ErrorsNULL_ARGUMENT timePeriodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOffering
Description

Registers for notification of an updated offering. OfferingReceiver.changedOfferings() is invoked when the specified offering in this catalogue is changed.

Parametersosid.id.IdofferingIdthe Id of the Offering to monitor
ErrorsNOT_FOUNDan offering was not found identified by the given Id
NULL_ARGUMENT offeringId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOfferings
Description

Registers for notification of deleted offerings. OfferingReceiver.deletedOfferings() is invoked when an offering is removed from this catalogue.

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

Registers for notification of deleted offerings for the given canonical unit. OfferingReceiver.changedOfferings() is invoked when an offering is remoevd from this catalogue.

Parametersosid.id.IdcanonicalUnitIdthe Id of the CanonicalUnit to monitor
ErrorsNULL_ARGUMENT canonicalUnitId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOfferingsForTimePeriod
Description

Registers for notification of updated offerings for the given time period. OfferingReceiver.changedOfferings() is invoked when an offering is removed from this catalogue.

Parametersosid.id.IdtimePeriodIdthe Id of the TimePeriod to monitor
ErrorsNULL_ARGUMENT timePeriodId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOffering
Description

Registers for notification of a deleted offering. OfferingReceiver.deletedOfferings() is invoked when the specified offering is removed from this catalogue.

Parametersosid.id.IdofferingIdthe Id of the Offering to monitor
ErrorsNOT_FOUNDan offering was not found identified by the given Id
NULL_ARGUMENT offeringId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.