OSID - osid.ontology.rules.RelevancyEnablerNotificationSession Service Interface Definition

Interface	osid.ontology.rules.RelevancyEnablerNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `RelevancyEnabler` objects in this `Ontology.` This also includes existing `RelevancyEnablers` that may appear or disappear due to changes in the `Ontology` 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 `RelevancyEnablerLookupSession.`
Method	getOntologyId
Description	Gets the `Ontology` `Id` associated with this session.
Return	`osid.id.Id`		the `Ontology Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOntology
Description	Gets the `Ontology` associated with this session.
Return	`osid.ontology.Ontology`		the ontology
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForRelevancyEnablerNotifications
Description	Tests if this user can register for `RelevancyEnabler` 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	useFederatedOntologyView
Description	Federates the view for methods in this session. A federated view will include enablers in ontologies which are children of this ontology in the ontology hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOntologyView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this ontology only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableRelevancyEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRelevancyEnablerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRelevancyEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRelevancyEnablerNotification
Description	Acknowledge a relevancy 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	registerForNewRelevancyEnablers
Description	Register for notifications of new relevancy enablers. `RelevancyEnablerReceiver.newRelevancyEnablers()` is invoked when a new `RelevancyEnabler` appears in this ontology.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRelevancyEnablers
Description	Registers for notification of updated ontology enabelrs. `RelevancyEnablerReceiver.changedRelevancyEnablers()` is invoked when a relevancy enabler in this ontology is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRelevancyEnabler
Description	Registers for notification of an updated relevancy enabler. `ProvisionableReceiver.changedRelevancyEnablers()` is invoked when the specified relevancy enabler in this ontology is changed.
Parameters	`osid.id.Id`	`relevancyEnablerId`	the `Id` of the `RelevancyEnabler` to monitor
Errors	NULL_ARGUMENT		`relevancyEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRelevancyEnablers
Description	Registers for notification of deleted relevancy enablers. `RelevancyEnablerReceiver.deletedRelevancyEnablers()` is invoked when a relevancy enabler is deleted or removed from this ontology.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRelevancyEnabler
Description	Registers for notification of a deleted relevancy enabler. `RelevancyEnablerReceiver.deletedRelevancyEnablers()` is invoked when the specified relevancy enabler is deleted or removed from this ontology.
Parameters	`osid.id.Id`	`relevancyEnablerId`	the `Id` of the `RelevancyEnabler` to monitor
Errors	NULL_ARGUMENT		`relevancyEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.