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

This session defines methods to receive notifications on adds/changes to CanonicalUnitEnabler objects in this Catalogue. This also includes existing CanonicalUnitEnablers 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 CanonicalUnitEnablerLookupSession.

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

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

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableCanonicalUnitEnablerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeCanonicalUnitEnablerNotification
Description

Acknowledge a canonical unit enabler notification.

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

Register for notifications of new canonical unit enablers. CanonicalUnitEnablerReceiver.newCanonicalUnitEnablers() is invoked when a new CanonicalUnitEnabler appears in this catalogue.

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

Registers for notification of updated canonical unit enablers. CanonicalUnitEnablerReceiver.changedCanonicalUnitEnablers() is invoked when a canonical unit enabler in this catalogue is changed.

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

Registers for notification of an updated canonical unit enabler. ProvisionableReceiver.changedCanonicalUnitEnablers() is invoked when the specified canonical unit enabler in this catalogue is changed.

Parametersosid.id.IdcanonicalUnitEnablerIdthe Id of the CanonicalUnitEnabler to monitor
ErrorsNULL_ARGUMENT canonicalUnitEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCanonicalUnitEnablers
Description

Registers for notification of deleted canonical unit enablers. CanonicalUnitEnablerReceiver.deletedCanonicalUnitEnablers() is invoked when a canonical unit enabler is deleted or removed from this catalogue.

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

Registers for notification of a deleted canonical unit enabler. CanonicalUnitEnablerReceiver.deletedCanonicalUnitEnablers() is invoked when the specified canonical unit enabler is deleted or removed from this catalogue.

Parametersosid.id.IdcanonicalUnitEnablerIdthe Id of the CanonicalUnitEnabler to monitor
ErrorsNULL_ARGUMENT canonicalUnitEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.