OSID Logo
OSID Specifications
profile rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.rules.ProfileEntryEnablerNotificationSession
Implementsosid.OsidSession
Description

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

MethodgetProfileId
Description

Gets the Profile Id associated with this session.

Returnosid.id.Idthe Profile Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetProfile
Description

Gets the Profile associated with this session.

Returnosid.profile.Profilethe profile
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForProfileEntryEnablerNotifications
Description

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

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

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedProfileView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodreliableProfileEntryEnablerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableProfileEntryEnablerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeProfileEntryEnablerNotification
Description

Acknowledge a profile entry enabler notification.

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

Register for notifications of new profile entry enablers. ProfileEntryEnablerReceiver.newProfileEntryEnablers() is invoked when a new ProfileEntryEnabler appears in this profile.

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

Registers for notification of updated profile enabelrs. ProfileEntryEnablerReceiver.changedProfileEntryEnablers() is invoked when a profile entry enabler in this profile is changed.

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

Registers for notification of an updated profile entry enabler. ProvisionableReceiver.changedProfileEntryEnablers() is invoked when the specified profile entry enabler in this profile is changed.

Parametersosid.id.IdprofileEntryEnablerIdthe Id of the ProfileEntryEnabler to monitor
ErrorsNULL_ARGUMENT profileEntryEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedProfileEntryEnablers
Description

Registers for notification of deleted profile entry enablers. ProfileEntryEnablerReceiver.deletedProfileEntryEnablers() is invoked when a profile entry enabler is deleted or removed from this profile.

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

Registers for notification of a deleted profile entry enabler. ProfileEntryEnablerReceiver.deletedProfileEntryEnablers() is invoked when the specified profile entry enabler is deleted or removed from this profile.

Parametersosid.id.IdprofileEntryEnablerIdthe Id of the ProfileEntryEnabler to monitor
ErrorsNULL_ARGUMENT profileEntryEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.