OSID - osid.profile.rules.ProfileEntryEnablerNotificationSession Service Interface Definition

Interface	osid.profile.rules.ProfileEntryEnablerNotificationSession
Implements	`osid.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.`
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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForProfileEntryEnablerNotifications
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.
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 enablers 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 to this profile only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableProfileEntryEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeProfileEntryEnablerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableProfileEntryEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeProfileEntryEnablerNotification
Description	Acknowledge a profile entry enabler 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	registerForNewProfileEntryEnablers
Description	Register for notifications of new profile entry enablers. `ProfileEntryEnablerReceiver.newProfileEntryEnablers()` is invoked when a new `ProfileEntryEnabler` appears in this profile.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProfileEntryEnablers
Description	Registers for notification of updated profile enabelrs. `ProfileEntryEnablerReceiver.changedProfileEntryEnablers()` is invoked when a profile entry enabler in this profile is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProfileEntryEnabler
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.
Parameters	`osid.id.Id`	`profileEntryEnablerId`	the `Id` of the `ProfileEntryEnabler` to monitor
Errors	NULL_ARGUMENT		`profileEntryEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProfileEntryEnablers
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.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProfileEntryEnabler
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.
Parameters	`osid.id.Id`	`profileEntryEnablerId`	the `Id` of the `ProfileEntryEnabler` to monitor
Errors	NULL_ARGUMENT		`profileEntryEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.