OSID Logo
OSID Specifications
resource demographic package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.demographic.DemographicEnablerNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to DemographicEnabler objects in this Bin. This also includes existing DemographicEnablers that may appear or disappear due to changes in the Bin 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 DemographicEnablerLookupSession.

MethodgetBinId
Description

Gets the Bin Id associated with this session.

Returnosid.id.Idthe Bin Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBin
Description

Gets the Bin associated with this session.

Returnosid.resource.Binthe bin
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForDemographicEnablerNotifications
Description

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

Federates the view for methods in this session. A federated view will include enablers in bins which are children of this bin in the bin hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBinView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewDemographicEnablers
Description

Register for notifications of new demographic enablers. DemographicEnablerReceiver.newDemographicEnablers() is invoked when a new DemographicEnabler appears in this bin.

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

Registers for notification of updated bin enabelrs. DemographicEnablerReceiver.changedDemographicEnablers() is invoked when a demographic enabler in this bin is changed.

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

Registers for notification of an updated demographic enabler. ProvisionableReceiver.changedDemographicEnablers() is invoked when the specified demographic enabler in this bin is changed.

Parametersosid.id.IddemographicEnablerProcessorIdthe Id of the DemographicEnabler to monitor
ErrorsNULL_ARGUMENT demographicEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedDemographicEnablers
Description

Registers for notification of deleted demographic enablers. DemographicEnablerReceiver.deletedDemographicEnablers() is invoked when a demographic enabler is deleted or removed from this bin.

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

Registers for notification of a deleted demographic enabler. DemographicEnablerReceiver.deletedDemographicEnablers() is invoked when the specified demographic enabler is deleted or removed from this bin.

Parametersosid.id.IddemographicEnablerIdthe Id of the DemographicEnabler to monitor
ErrorsNULL_ARGUMENT demographicEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.