OSID - osid.profile.ProfileNotificationSession Service Interface Definition

Interface	osid.profile.ProfileNotificationSession
Implements	`osid.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.
Method	canRegisterForProfileNotifications
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.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	reliableProfileNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeProfileNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableProfileNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeProfileNotification
Description	Acknowledge a profile notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProfiles
Description	Register for notifications of new profiles. `ProfileReceiver.newProfiles()` is invoked when a new `Profile` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProfiles
Description	Registers for notification of updated profiles. `ProfileReceiver.changedProfiles()` is invoked when a profile is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProfile
Description	Registers for notification of an updated profile. `ProfileReceiver.changedProfiles()` is invoked when the specified profile is changed.
Parameters	`osid.id.Id`	`profileId`	the Id of the profile to monitor
Errors	NULL_ARGUMENT		`profileId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProfiles
Description	Registers for notification of deleted profiles. `ProfileReceiver.deletedProfiles()` is invoked when a profile is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProfile
Description	Registers for notification of a deleted profile. `ProfileReceiver.deletedProfiles()` is invoked when the specified profile is deleted.
Parameters	`osid.id.Id`	`profileId`	the Id of the profile to monitor
Errors	NULL_ARGUMENT		`profileId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProfileHierarchy
Description	Registers for notification of an updated profile hierarchy structure. `ProfileReceiver.changedChildOfProfiless()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProfileHierarchyForAncestors
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.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the `Profile` node to monitor
Errors	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProfileHierarchyForDescendants
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.
Parameters	`osid.id.Id`	`profileId`	the `Id` of the `Profile` node to monitor
Errors	NULL_ARGUMENT		`profileId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.