OSID - osid.course.requisite.RequisiteNotificationSession Service Interface Definition

Interface	osid.course.requisite.RequisiteNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Requisite` objects in this `CourseCatalog.` This also includes existing courses that may appear or disappear due to changes in the `CourseCatalog` 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 `RequisiteLookupSession.`
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForRequisiteNotifications
Description	Tests if this user can register for `Requisite` 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	useFederatedCourseCatalogView
Description	Federates the view for methods in this session. A federated view will include requisites in catalogs which are children of this catalog in the course catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCourseCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableRequisiteNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRequisiteNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRequisiteNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRequisiteNotification
Description	Acknowledge a requisite 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	registerForNewRequisites
Description	Register for notifications of new requisites. `RequisiteReceiver.newRequisites()` is invoked when a new `Requisite` appears in this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRequisites
Description	Registers for notification of updated requisites. `RequisiteReceiver.changedRequisites()` is invoked when a requisite in this course catalog is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRequisite
Description	Registers for notification of an updated requisite. `RequisiteReceiver.changedRequisites()` is invoked when the specified requisite in this course catalog is changed.
Parameters	`osid.id.Id`	`requisiteId`	the `Id` of the `Requisite` to monitor
Errors	NULL_ARGUMENT		`requisiteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRequisites
Description	Registers for notification of deleted requisites. `RequisiteReceiver.deletedRequisites()` is invoked when a requisite is deleted or removed from this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRequisite
Description	Registers for notification of a deleted requisite. `RequisiteReceiver.deletedRequisites()` is invoked when the specified requisite is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`requisiteId`	the `Id` of the `Requisite` to monitor
Errors	NULL_ARGUMENT		`requisiteId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCourseRequirements
Description	Register for notifications of new course requirements. `RequisiteReceiver.newCourseRequirements()` is invoked when a new `CourseRequirement` appears in this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCourseRequirements
Description	Registers for notification of updated course requirements. `RequisiteReceiver.changedCourseRequirements()` is invoked when a course requirement in this course catalog is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCourseRequirement
Description	Registers for notification of an updated course requirement. `RequisiteReceiver.changedCourseRequirements()` is invoked when the specified course requirement in this course catalog is changed.
Parameters	`osid.id.Id`	`courseRequirementId`	the `Id` of the `CourseRequirement` to monitor
Errors	NULL_ARGUMENT		`courseRequirementId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCourseRequirements
Description	Registers for notification of deleted course requirements. `RequisiteReceiver.deletedCourseRequirements()` is invoked when a course requirement is deleted or removed from this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCourseRequirement
Description	Registers for notification of a deleted course requirement. `RequisiteReceiver.deletedCourseRequirements()` is invoked when the specified course requirement is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`courseRequirementId`	the `Id` of the `CourseRequirement` to monitor
Errors	NULL_ARGUMENT		`courseRequirementId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewProgramRequirements
Description	Register for notifications of new program requirements. `RequisiteReceiver.newProgramRequirements()` is invoked when a new `ProgramRequirement` appears in this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProgramRequirements
Description	Registers for notification of updated program requirements. `RequisiteReceiver.changedProgramRequirements()` is invoked when a program requirement in this course catalog is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProgramRequirement
Description	Registers for notification of an updated program requirement. `RequisiteReceiver.changedProgramRequirements()` is invoked when the specified program requirement in this course catalog is changed.
Parameters	`osid.id.Id`	`programRequirementId`	the `Id` of the `ProgramRequirement` to monitor
Errors	NULL_ARGUMENT		`programRequirementId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProgramRequirements
Description	Registers for notification of deleted program requirements. `RequisiteReceiver.deletedProgramRequirements()` is invoked when a program requirement is deleted or removed from this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProgramRequirement
Description	Registers for notification of a deleted program requirement. `RequisiteReceiver.deletedProgramRequirements()` is invoked when the specified program requirement is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`programRequirementId`	the `Id` of the `ProgramRequirement` to monitor
Errors	NULL_ARGUMENT		`programRequirementId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCredentialRequirements
Description	Register for notifications of new credential requirements. `RequisiteReceiver.newCredentialRequirements()` is invoked when a new `CredentialRequirement` appears in this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCredentialRequirements
Description	Registers for notification of updated credential requirements. `RequisiteReceiver.changedCredentialRequirements()` is invoked when a credential requirement in this course catalog is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCredentialRequirement
Description	Registers for notification of an updated credential requirement. `RequisiteReceiver.changedCredentialRequirements()` is invoked when the specified credential requirement in this course catalog is changed.
Parameters	`osid.id.Id`	`credentialRequirementId`	the `Id` of the `CredentialRequirement` to monitor
Errors	NULL_ARGUMENT		`credentialRequirementId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCredentialRequirements
Description	Registers for notification of deleted credential requirements. `RequisiteReceiver.deletedCredentialRequirements()` is invoked when a credential requirement is deleted or removed from this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCredentialRequirement
Description	Registers for notification of a deleted credential requirement. `RequisiteReceiver.deletedCredentialRequirements()` is invoked when the specified credential requirement is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`credentialRequirementId`	the `Id` of the `CredentialRequirement` to monitor
Errors	NULL_ARGUMENT		`credentialRequirementId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewLearningObjectiveRequirements
Description	Register for notifications of new learning objective requirements. `RequisiteReceiver.newLearningObjectiveRequirements()` is invoked when a new `LearningObjectiveRequirement` appears in this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLearningObjectiveRequirements
Description	Registers for notification of updated learning objective requirements. `RequisiteReceiver.changedLearningObjectiveRequirements()` is invoked when a learning objective requirement in this course catalog is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLearningObjectiveRequirement
Description	Registers for notification of an updated learning objective requirement. `RequisiteReceiver.changedLearningObjectiveRequirements()` is invoked when the specified learning objective requirement in this course catalog is changed.
Parameters	`osid.id.Id`	`learningObjectiveRequirementId`	the `Id` of the `LearningObjectiveRequirement` to monitor
Errors	NULL_ARGUMENT		`learningObjectiveRequirementId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLearningObjectiveRequirements
Description	Registers for notification of deleted learning objective requirements. `RequisiteReceiver.deletedLearningObjectiveRequirements()` is invoked when a learning objective requirement is deleted or removed from this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLearningObjectiveRequirement
Description	Registers for notification of a deleted learning objective requirement. `RequisiteReceiver.deletedLearningObjectiveRequirements()` is invoked when the specified learning objective requirement is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`learningObjectiveRequirementId`	the `Id` of the `LearningObjectiveRequirement` to monitor
Errors	NULL_ARGUMENT		`learningObjectiveRequirementId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewAssessmentRequirements
Description	Register for notifications of new assessment requirements. `RequisiteReceiver.newAssessmentRequirements()` is invoked when a new `AssessmentRequirement` appears in this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAssessmentRequirements
Description	Registers for notification of updated assessment requirements. `RequisiteReceiver.changedAssessmentRequirements()` is invoked when an assessment requirement in this course catalog is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAssessmentRequirement
Description	Registers for notification of an updated assessment requirement. `RequisiteReceiver.changedAssessmentRequirements()` is invoked when the specified assessment requirement in this course catalog is changed.
Parameters	`osid.id.Id`	`assessmentRequirementId`	the `Id` of the `AssessmentRequirement` to monitor
Errors	NULL_ARGUMENT		`assessmentRequirementId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAssessmentRequirements
Description	Registers for notification of deleted assessment requirements. `RequisiteReceiver.deletedAssessmentRequirements()` is invoked when an assessment requirement is deleted or removed from this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAssessmentRequirement
Description	Registers for notification of a deleted assessment requirement. `RequisiteReceiver.deletedAssessmentRequirements()` is invoked when the specified assessment requirement is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`assessmentRequirementId`	the `Id` of the `AssessmentRequirement` to monitor
Errors	NULL_ARGUMENT		`assessmentRequirementId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewAwardRequirements
Description	Register for notifications of new award requirements. `RequisiteReceiver.newAwardRequirements()` is invoked when a new `AwardRequirement` appears in this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAwardRequirements
Description	Registers for notification of updated award requirements. `RequisiteReceiver.changedAwardRequirements()` is invoked when an award requirement in this course catalog is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAwardRequirement
Description	Registers for notification of an updated award requirement. `RequisiteReceiver.changedAwardRequirements()` is invoked when the specified award requirement in this course catalog is changed.
Parameters	`osid.id.Id`	`awardRequirementId`	the `Id` of the `AwardRequirement` to monitor
Errors	NULL_ARGUMENT		`awardRequirementId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAwardRequirements
Description	Registers for notification of deleted award requirements. `RequisiteReceiver.deletedAwardRequirements()` is invoked when an award requirement is deleted or removed from this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAwardRequirement
Description	Registers for notification of a deleted award requirement. `RequisiteReceiver.deletedAwardRequirements()` is invoked when the specified award requirement is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`awardRequirementId`	the `Id` of the `AwardRequirement` to monitor
Errors	NULL_ARGUMENT		`awardRequirementId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.