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

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

MethodcanRegisterForProfileNotifications
Description

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

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableProfileNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeProfileNotification
Description

Acknowledge a profile notification.

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

Register for notifications of new profiles. ProfileReceiver.newProfiles() is invoked when a new Profile is created.

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

Registers for notification of updated profiles. ProfileReceiver.changedProfiles() is invoked when a profile is changed.

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

Registers for notification of an updated profile. ProfileReceiver.changedProfiles() is invoked when the specified profile is changed.

Parametersosid.id.IdprofileIdthe Id of the profile to monitor
ErrorsNULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedProfiles
Description

Registers for notification of deleted profiles. ProfileReceiver.deletedProfiles() is invoked when a profile is deleted.

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

Registers for notification of a deleted profile. ProfileReceiver.deletedProfiles() is invoked when the specified profile is deleted.

Parametersosid.id.IdprofileIdthe Id of the profile to monitor
ErrorsNULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedProfileHierarchy
Description

Registers for notification of an updated profile hierarchy structure. ProfileReceiver.changedChildOfProfiless() is invoked when a node experiences a change in its children.

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

Registers for notification of an updated profile hierarchy structure. ProfileReceiver.changedChildOfProfiles() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdprofileIdthe Id of the Profile node to monitor
ErrorsNULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedProfileHierarchyForDescendants
Description

Registers for notification of an updated profile hierarchy structure. ProfileReceiver.changedChildOfProfiles() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdprofileIdthe Id of the Profile node to monitor
ErrorsNULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.