OSID - osid.ontology.SubjectNotificationSession Service Interface Definition

Interface	osid.ontology.SubjectNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive asynchronous notifications on adds/changes to `Subject` 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. The views defined in this session correspond to the views in the `SubjectLookupSession.`
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	canRegisterForSubjectNotifications
Description	Tests if this user can register for `Subject` 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 subjects 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	reliableSubjectNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeSubjectNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableSubjectNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeSubjectNotification
Description	Acknowledge a subject 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	registerForNewSubjects
Description	Register for notifications of new subjects. `SubjectReceiver.newSubjects()` is invoked when a new subject is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSubjects
Description	Registers for notification of updated subjects. `SubjectReceiver.changedSubjects()` is invoked when a subject is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSubject
Description	Registers for notification of an updated subject. `SubjectReceiver.changedSubjects()` is invoked when the specified subject 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	registerForDeletedSubjects
Description	Registers for notification of deleted subjects. `SubjectReceiver.deletedSubjects()` is invoked when a subject is removed from this ontology.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedSubject
Description	Registers for notification of a deleted subject. `SubjectReceiver.changedSubjects()` is invoked when the specified subject is removed from this ontology.
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	registerForChangedSubjectHierarchy
Description	Registers for notification of an updated subject hierarchy structure. `SubjectReceiver.changedChildOfSubjects()` 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	registerForChangedSubjectHierarchyForAncestors
Description	Registers for notification of an updated subject hierarchy structure. `SubjectReceiver.changedChildOfSubjects()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`subjectId`	the `Id` of the `Subject` node 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	registerForChangedSubjectHierarchyForDescendants
Description	Registers for notification of an updated subject hierarchy structure. `SubjectReceiver.changedChildOfSubjects()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`subjectId`	the `Id` of the `Subject` node 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.