OSID - osid.profile.ProfileEntryNotificationSession Service Interface Definition

Interface	osid.profile.ProfileEntryNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.profile.ProfileManager`
Used By	`osid.profile.ProfileProxyManager`
Description	This session defines methods to receive asynchronous notifications on adds/changes to `ProfileEntries`. 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 views defined in this session correspond to the views in the `ProfileEntryLookupSession`.
Method	getProfileId
Description	Gets the `Profile` `Id` associated with this session.
Return	`osid.id.Id`		the `Profile Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getProfile
Description	Gets the `Profile` associated with this session.
Return	`osid.profile.Profile`		the `Profile` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForProfileEntryNotifications
Description	Tests if this user can register for `ProfileEntry` 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	useFederatedProfileView
Description	Federates the view for methods in this session. A federated view will include profile entries in profiles which are children of this profile in the profile hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedProfileView
Description	Isolates the view for methods in this session. An isolated view restricts notifications for profile entries in this profile only.
Compliance	`mandatory`		This method is must be implemented.
Method	useImplicitProfileEntryView
Description	Sets the view for methods in this session to implicit profile entries. An implicit view will include profile entries derived from other authorizations as a result of the `ProfileItem` or `Resource` hierarchies. This method is the opposite of `explicitProfileEntryView()`.
Compliance	`mandatory`		This method is must be implemented.
Method	useExplicitProfileEntryView
Description	Sets the view for methods in this session to explicit profile entries. An explicit view includes only those entries that were explicitly defined and not implied. This method is the opposite of `implicitProfileEntryView()`.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableProfileEntryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeProfileEntryNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableProfileEntryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeProfileEntryNotification
Description	Acknowledge a profile entry 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	registerForNewProfileEntries
Description	Register for notifications of new profile entries. `ProfileEntryReceiver.newProfileEntries()` is invoked when a new `ProfileEntry` appears in this profile.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProfileEntriesForResource
Description	Registers for notification of new profile entries for the given resource including any profile entries related to the resource through an agent. `ProfileEntryReceiver.newProfileEntries()` is invoked when a profile entry appears in this profile.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProfileEntriesForProfileItem
Description	Register for notifications of new profile entries for the given profile item. `ProfileEntryReceiver.newProfileEntries()` is invoked when a new `ProfileEntry` appears in this profile.
Parameters	`osid.id.Id`	`profileItemId`	the `Id` of the `ProfileItem` to monitor
Errors	NULL_ARGUMENT		`profileItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProfileEntries
Description	Registers for notification of updated profile entries. `ProfileEntryReceiver.changedProfileEntries()` is invoked when an entry is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProfileEntriesForResource
Description	Registers for notification of updated profile entries for the given resource including any profile entries related to the resource through an agent. `ProfileEntryReceiver.changedProfileEntries()` is invoked when a profile entry in this profile is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProfileEntriesForProfileItem
Description	Register for notifications of updated profile entries for the given profile item. `ProfileEntryReceiver.changedProfileEntry()` is invoked when a new `ProfileEntry` in this profile is changed.
Parameters	`osid.id.Id`	`profileItemId`	the `Id` of the `ProfileItem` to monitor
Errors	NULL_ARGUMENT		`profileItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProfileEntry
Description	Registers for notification of an updated profile entry. `ProfileEntryReceiver.changedProfileEntries()` is invoked when the specified entry in this profile changed.
Parameters	`osid.id.Id`	`profileEntryId`	the `Id` of the `ProfileEntry` to monitor
Errors	NULL_ARGUMENT		`profileEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProfileEntries
Description	Registers for notification of deleted profile entries. `ProfileEntryReceiver.deletedProfileEntries()` is invoked when a profile entry is removed from this profile.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProfileEntriesForResource
Description	Registers for notification of deleted profile entries for the given resource including any profile entries related to the resource through an agent. `ProfileEntryReceiver.changedProfileEntries()` is invoked when a profile entry is removed from this profile.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProfileEntriesForProfileItem
Description	Register for notifications of deleted profile entries for the given profile item. `ProfileEntryReceiver.deletedProfileEntries()` is invoked when a `ProfileEntry` is removed from this profile.
Parameters	`osid.id.Id`	`profileItemId`	the `Id` of the `ProfileItem` to monitor
Errors	NULL_ARGUMENT		`profileItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProfileEntry
Description	Registers for notification of a deleted profile entry. `ProfileEntryReceiver.deletedProfileEntries()` is invoked when the specified entry is removed from this profile.
Parameters	`osid.id.Id`	`profileEntryId`	the `Id` of the `ProfileEntry` to monitor
Errors	NULL_ARGUMENT		`profileEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.