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

This session defines methods to receive notifications on adds/changes to OfferingConstrainerEnabler objects in this Catalogue. This also includes existing OfferingConstrainerEnablers that may appear or disappear due to changes in the Catalogue hierarchy, 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.

The two views defined in this session correspond to the views in the OfferingConstrainerEnablerLookupSession.

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.
MethodcanRegisterForOfferingConstrainerEnablerNotifications
Description

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

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeOfferingConstrainerEnablerNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableOfferingConstrainerEnablerNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeOfferingConstrainerEnablerNotification
Description

Acknowledge an offering constrainer enabler notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewOfferingConstrainerEnablers
Description

Register for notifications of new offering constrainer enablers. OfferingConstrainerEnablerReceiver.newOfferingConstrainerEnablers() is invoked when a new OfferingConstrainerEnabler appears in this catalogue.

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

Registers for notification of updated offering constrainer enablers. OfferingConstrainerEnablerReceiver.changedOfferingConstrainerEnablers() is invoked when an offering constrainer enabler in this catalogue is changed.

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

Registers for notification of an updated offering constrainer enabler. ProvisionableReceiver.changedOfferingConstrainerEnablers() is invoked when the specified offering constrainer enabler in this catalogue is changed.

Parametersosid.id.IdofferingConstrainerEnablerIdthe Id of the OfferingConstrainerEnabler to monitor
ErrorsNULL_ARGUMENT offeringConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOfferingConstrainerEnablers
Description

Registers for notification of deleted offering constrainer enablers. OfferingConstrainerEnablerReceiver.deletedOfferingConstrainerEnablers() is invoked when an offering constrainer enabler is deleted or removed from this catalogue.

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

Registers for notification of a deleted offering constrainer enabler. OfferingConstrainerEnablerReceiver.deletedOfferingConstrainerEnablers() is invoked when the specified offering constrainer enabler is deleted or removed from this catalogue.

Parametersosid.id.IdofferingConstrainerEnablerIdthe Id of the OfferingConstrainerEnabler to monitor
ErrorsNULL_ARGUMENT offeringConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.