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

This session defines methods to receive notifications on adds/changes to Demographic objects in this Bin. This also includes existing Demographics 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 DemographicLookupSession.

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

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

Register for notifications of new demographics. DemographicReceiver.newDemographics() is invoked when a new Demographic appears in this bin.

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

Registers for notification of updated demographics. DemographicReceiver.changedDemographics() is invoked when a demographic in this bin is changed.

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

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

Parametersosid.id.IddemographicIdthe Id of the Demographic to monitor
ErrorsNULL_ARGUMENT demographicId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedDemographics
Description

Registers for notification of deleted demographics. DemographicReceiver.deletedDemographics() is invoked when a demographic is deleted or removed from this bin.

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

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

Parametersosid.id.IddemographicIdthe Id of the Demographic to monitor
ErrorsNULL_ARGUMENT demographicId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.