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

This session defines methods to receive asynchronous notifications on adds/changes to ProfileItem objects. 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 ProfileItemLookupSession.

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 associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForProfileItemNotifications
Description

Tests if this user can register for ProfileItem 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 items 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.
MethodreliableProfileItemNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableProfileItemNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeProfileItemNotification
Description

Acknowledge a profile item notification.

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

Register for notifications of new pofile items. ProfileItemReceiver.newProfileItems() is invoked when a new ProfileItem is created.

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

Registers for notification of updated profile items. ProfileItemReceiver.changedProfileItems() is invoked when a profile item is changed.

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

Registers for notification of an updated profile item. ProfileItemReceiver.changedProfileItems() is invoked when the specified profile item is changed.

Parametersosid.id.IdprofileItemIdthe Id of the ProfileItem to monitor
ErrorsNULL_ARGUMENT profileItemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedProfileItems
Description

Registers for notification of deleted profile items. ProfileItemReceiver.deletedProfileItems() is invoked when a profile is removed from this profile.

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

Registers for notification of a deleted profile item. ProfileItemReceiver.changedProfileItems() is invoked when the specified profile item is removed from this profile.

Parametersosid.id.IdprofileItemIdthe Id of the ProfileItem to monitor
ErrorsNULL_ARGUMENT profileItemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.