OSID - osid.ontology.RelevancyNotificationSession Service Interface Definition

Interface	osid.ontology.RelevancyNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive asynchronous notifications on adds/changes to subject relevancies. 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 `RelevancyLookupSession.`
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForRelevancyNotifications
Description	Tests if this user can register for `Relevancy` 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 notifications for relevancies 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	reliableRelevancyNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRelevancyNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRelevancyNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRelevancyNotification
Description	Acknowledge a relevancy 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	registerForNewRelevancies
Description	Register for notifications of new relevancies. `RelevancyReceiver.newRelevancies()` is invoked when a new relevancy is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRelevanciesByGenusType
Description	Register for notifications of new relevancies by the given genus type. `RelevancyReceiver.newRelevancies()` is invoked when a new relevancy is created.
Parameters	`osid.type.Type`	`relevancyGenusType`	the relevancy genus type
Errors	NULL_ARGUMENT		`relevancyGenusType is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRelevanciesForSubject
Description	Register for notifications of new relevancies for the given subject. `RelevancyReceiver.newRelevancies()` is invoked when a new relevancy is created.
Parameters	`osid.id.Id`	`subjectId`	the `Id` of the `Subject` to monitor
Errors	NULL_ARGUMENT		`subjectId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRelevanciesForId
Description	Register for notifications of new relevancies for the given mapped `Id.` `RelevancyReceiver.newRelevancies()` is invoked when a new relevancy is created.
Parameters	`osid.id.Id`	`id`	the `Id` to monitor
Errors	NULL_ARGUMENT		`id is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRelevancies
Description	Registers for notification of updated relevancies. `RelevancyReceiver.changedRelevancies()` is invoked when a relevancy is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRelevanciesByGenusType
Description	Register for notifications of changed relevancies of the given genus type. `RelevancyReceiver.changedRelevancies()` is invoked when a relevancy is changed.
Parameters	`osid.type.Type`	`relevancyGenusType`	the relevancy genus type
Errors	NULL_ARGUMENT		`relevancyGenusType is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRelevanciesForSubject
Description	Register for notifications of changed relevancies for the given subject. `RelevancyReceiver.changedRelevancies()` is invoked when a relevancy is changed.
Parameters	`osid.id.Id`	`subjectId`	the `Id` of the `Subject` to monitor
Errors	NULL_ARGUMENT		`subjectId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRelevanciesForId
Description	Register for notifications of changed relevancies for the given `Id.` `RelevancyReceiver.changedRelevancies()` is invoked when a relevancy is changed.
Parameters	`osid.id.Id`	`id`	the `Id` to monitor
Errors	NULL_ARGUMENT		`id is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRelevancy
Description	Registers for notification of an updated relevancy. `RelevancyReceiver.changedRelevancies()` is invoked when the specified relevancy is changed.
Parameters	`osid.id.Id`	`relevancyId`	the `Id` of the `Relevancy` to monitor
Errors	NULL_ARGUMENT		`relevancyId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRelevancies
Description	Registers for notification of deleted relevancies. `RelevancyReceiver.deletedRelevancies()` is invoked when a relevancy is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRelevanciesByGenusType
Description	Register for notifications of deleted relevancies of the given genus type. `RelevancyReceiver.deletedRelevancies()` is invoked when a relevancy is deleted.
Parameters	`osid.type.Type`	`relevancyGenusType`	the relevancy genus type
Errors	NULL_ARGUMENT		`relevancyGenusType is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRelevanciesForSubject
Description	Register for notifications of deleted relevancies for the given subject. `RelevancyReceiver.deletedRelevancies()` is invoked when a relevancy is deleted.
Parameters	`osid.id.Id`	`subjectId`	the `Id` of the `Subject` to monitor
Errors	NULL_ARGUMENT		`subjectId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRelevanciesForId
Description	Register for notifications of deleted relevancies for the given `Id.` `RelevancyReceiver.deletedRelevancies()` is invoked when a relevancy is deleted.
Parameters	`osid.id.Id`	`id`	the `Id` to monitor
Errors	NULL_ARGUMENT		`id is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRelevancy
Description	Registers for notification of a deleted relevancy. `RelevancyReceiver.changedRelevancies()` is invoked when the specified relevancy is deleted.
Parameters	`osid.id.Id`	`relevancyId`	the `Id` of the `Relevancy` to monitor
Errors	NULL_ARGUMENT		`relevancyId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.