OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.ProgramOfferingNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to ProgramOfferings in this CourseCatalog. This also includes existing program offerings 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 ProgramOfferingLookupSession.

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.
MethodcanRegisterForProgramOfferingNotifications
Description

Tests if this user can register for ProgramOffering 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 program offerings 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.
MethodreliableProgramOfferingNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableProgramOfferingNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeProgramOfferingNotification
Description

Acknowledge a program offering notification.

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

Register for notifications of new program offerings. ProgramOfferingReceiver.newProgramOfferings() is invoked when a new ProgramOffering appears in this course catalog.

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

Registers for notification of new program offerings for a program. ProgramOfferingReceiver.newProgramOfferings() is invoked when the specified program offering appears in this course catalog.

Parametersosid.id.IdprogramIdthe Id of the Program to monitor
ErrorsNULL_ARGUMENT programId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewProgramOfferingsForTerm
Description

Registers for notification of new program offerings for a term. ProgramOfferingReceiver.newProgramOfferings() is invoked when the specified program offering appears in this course catalog.

Parametersosid.id.IdtermIdthe Id of the Term to monitor
ErrorsNULL_ARGUMENT termId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedProgramOfferings
Description

Registers for notification of updated programs. ProgramOfferingReceiver.changedProgramOfferings() is invoked when a program offering in this course catalog is changed.

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

Registers for notification of updated program offerings for a program. ProgramOfferingReceiver.changedProgramOfferings() is invoked when a program offering in this course catalog is changed.

Parametersosid.id.IdprogramIdthe Id of the Program to monitor
ErrorsNULL_ARGUMENT programId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedProgramOfferingsForTerm
Description

Registers for notification of updated program offerings for a term. ProgramOfferingReceiver.changedProgramOfferings() is invoked when a program offering in this course catalog is changed.

Parametersosid.id.IdtermIdthe Id of the Term to monitor
ErrorsNULL_ARGUMENT termId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedProgramOffering
Description

Registers for notification of an updated program offering. ProgramOfferingReceiver.changedProgramOffering() is invoked when the specified program offering in this course catalog is changed.

Parametersosid.id.IdprogramOfferingIdthe Id of the ProgramOffering to monitor
ErrorsNULL_ARGUMENT programOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedProgramOfferings
Description

Registers for notification of deleted programs. ProgramOfferingReceiver.deletedProgramOfferings() is invoked when a program offering is deleted or removed from this course catalog.

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

Registers for notification of deleted program offerings for a program. ProgramOfferingReceiver.deletedProgramOfferings() is invoked when a program offering in this course catalog is removed.

Parametersosid.id.IdprogramIdthe Id of the Program to monitor
ErrorsNULL_ARGUMENT programId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedProgramOfferingsForTerm
Description

Registers for notification of updated program offerings for a term. ProgramOfferingReceiver.deletedProgramOfferings() is invoked when a program offering in this course catalog is removed.

Parametersosid.id.IdtermIdthe Id of the Term to monitor
ErrorsNULL_ARGUMENT termId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedProgramOffering
Description

Registers for notification of a deleted program offering. ProgramOfferingReceiver.deletedProgramOfferings() is invoked when the specified program offering is deleted or removed from this course catalog.

Parametersosid.id.IdprogramOfferingIdthe Id of the ProgramOffering to monitor
ErrorsNULL_ARGUMENT programOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.