OSID Logo
OSID Specifications
course requisite package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.requisite.RequisiteNotificationSession
Implementsosid.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.

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Idthe CourseCatalog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalogthe course catalog
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForRequisiteNotifications
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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedCourseCatalogView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCourseCatalogView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethodreliableRequisiteNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeRequisiteNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableRequisiteNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeRequisiteNotification
Description

Acknowledge a requisite notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewRequisites
Description

Register for notifications of new requisites. RequisiteReceiver.newRequisites() is invoked when a new Requisite appears in this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRequisites
Description

Registers for notification of updated requisites. RequisiteReceiver.changedRequisites() is invoked when a requisite in this course catalog is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRequisite
Description

Registers for notification of an updated requisite. RequisiteReceiver.changedRequisites() is invoked when the specified requisite in this course catalog is changed.

Parametersosid.id.IdrequisiteIdthe Id of the Requisite to monitor
ErrorsNULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRequisites
Description

Registers for notification of deleted requisites. RequisiteReceiver.deletedRequisites() is invoked when a requisite is deleted or removed from this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRequisite
Description

Registers for notification of a deleted requisite. RequisiteReceiver.deletedRequisites() is invoked when the specified requisite is deleted or removed from this course catalog.

Parametersosid.id.IdrequisiteIdthe Id of the Requisite to monitor
ErrorsNULL_ARGUMENT requisiteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCourseRequirements
Description

Register for notifications of new course requirements. RequisiteReceiver.newCourseRequirements() is invoked when a new CourseRequirement appears in this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCourseRequirements
Description

Registers for notification of updated course requirements. RequisiteReceiver.changedCourseRequirements() is invoked when a course requirement in this course catalog is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCourseRequirement
Description

Registers for notification of an updated course requirement. RequisiteReceiver.changedCourseRequirements() is invoked when the specified course requirement in this course catalog is changed.

Parametersosid.id.IdcourseRequirementIdthe Id of the CourseRequirement to monitor
ErrorsNULL_ARGUMENT courseRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCourseRequirements
Description

Registers for notification of deleted course requirements. RequisiteReceiver.deletedCourseRequirements() is invoked when a course requirement is deleted or removed from this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCourseRequirement
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.

Parametersosid.id.IdcourseRequirementIdthe Id of the CourseRequirement to monitor
ErrorsNULL_ARGUMENT courseRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewProgramRequirements
Description

Register for notifications of new program requirements. RequisiteReceiver.newProgramRequirements() is invoked when a new ProgramRequirement appears in this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedProgramRequirements
Description

Registers for notification of updated program requirements. RequisiteReceiver.changedProgramRequirements() is invoked when a program requirement in this course catalog is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedProgramRequirement
Description

Registers for notification of an updated program requirement. RequisiteReceiver.changedProgramRequirements() is invoked when the specified program requirement in this course catalog is changed.

Parametersosid.id.IdprogramRequirementIdthe Id of the ProgramRequirement to monitor
ErrorsNULL_ARGUMENT programRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedProgramRequirements
Description

Registers for notification of deleted program requirements. RequisiteReceiver.deletedProgramRequirements() is invoked when a program requirement is deleted or removed from this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedProgramRequirement
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.

Parametersosid.id.IdprogramRequirementIdthe Id of the ProgramRequirement to monitor
ErrorsNULL_ARGUMENT programRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewCredentialRequirements
Description

Register for notifications of new credential requirements. RequisiteReceiver.newCredentialRequirements() is invoked when a new CredentialRequirement appears in this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCredentialRequirements
Description

Registers for notification of updated credential requirements. RequisiteReceiver.changedCredentialRequirements() is invoked when a credential requirement in this course catalog is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedCredentialRequirement
Description

Registers for notification of an updated credential requirement. RequisiteReceiver.changedCredentialRequirements() is invoked when the specified credential requirement in this course catalog is changed.

Parametersosid.id.IdcredentialRequirementIdthe Id of the CredentialRequirement to monitor
ErrorsNULL_ARGUMENT credentialRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCredentialRequirements
Description

Registers for notification of deleted credential requirements. RequisiteReceiver.deletedCredentialRequirements() is invoked when a credential requirement is deleted or removed from this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedCredentialRequirement
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.

Parametersosid.id.IdcredentialRequirementIdthe Id of the CredentialRequirement to monitor
ErrorsNULL_ARGUMENT credentialRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewLearningObjectiveRequirements
Description

Register for notifications of new learning objective requirements. RequisiteReceiver.newLearningObjectiveRequirements() is invoked when a new LearningObjectiveRequirement appears in this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedLearningObjectiveRequirements
Description

Registers for notification of updated learning objective requirements. RequisiteReceiver.changedLearningObjectiveRequirements() is invoked when a learning objective requirement in this course catalog is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedLearningObjectiveRequirement
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.

Parametersosid.id.IdlearningObjectiveRequirementIdthe Id of the LearningObjectiveRequirement to monitor
ErrorsNULL_ARGUMENT learningObjectiveRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedLearningObjectiveRequirements
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.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedLearningObjectiveRequirement
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.

Parametersosid.id.IdlearningObjectiveRequirementIdthe Id of the LearningObjectiveRequirement to monitor
ErrorsNULL_ARGUMENT learningObjectiveRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewAssessmentRequirements
Description

Register for notifications of new assessment requirements. RequisiteReceiver.newAssessmentRequirements() is invoked when a new AssessmentRequirement appears in this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAssessmentRequirements
Description

Registers for notification of updated assessment requirements. RequisiteReceiver.changedAssessmentRequirements() is invoked when an assessment requirement in this course catalog is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAssessmentRequirement
Description

Registers for notification of an updated assessment requirement. RequisiteReceiver.changedAssessmentRequirements() is invoked when the specified assessment requirement in this course catalog is changed.

Parametersosid.id.IdassessmentRequirementIdthe Id of the AssessmentRequirement to monitor
ErrorsNULL_ARGUMENT assessmentRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAssessmentRequirements
Description

Registers for notification of deleted assessment requirements. RequisiteReceiver.deletedAssessmentRequirements() is invoked when an assessment requirement is deleted or removed from this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAssessmentRequirement
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.

Parametersosid.id.IdassessmentRequirementIdthe Id of the AssessmentRequirement to monitor
ErrorsNULL_ARGUMENT assessmentRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewAwardRequirements
Description

Register for notifications of new award requirements. RequisiteReceiver.newAwardRequirements() is invoked when a new AwardRequirement appears in this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAwardRequirements
Description

Registers for notification of updated award requirements. RequisiteReceiver.changedAwardRequirements() is invoked when an award requirement in this course catalog is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedAwardRequirement
Description

Registers for notification of an updated award requirement. RequisiteReceiver.changedAwardRequirements() is invoked when the specified award requirement in this course catalog is changed.

Parametersosid.id.IdawardRequirementIdthe Id of the AwardRequirement to monitor
ErrorsNULL_ARGUMENT awardRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAwardRequirements
Description

Registers for notification of deleted award requirements. RequisiteReceiver.deletedAwardRequirements() is invoked when an award requirement is deleted or removed from this course catalog.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedAwardRequirement
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.

Parametersosid.id.IdawardRequirementIdthe Id of the AwardRequirement to monitor
ErrorsNULL_ARGUMENT awardRequirementId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.