Interface | osid.course.program.ProgramOfferingNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForProgramOfferingNotifications | ||
Description |
Tests if this user can register for | ||
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 program offerings 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 | reliableProgramOfferingNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableProgramOfferingNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeProgramOfferingNotification | ||
Description |
Acknowledge a program offering notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewProgramOfferings | ||
Description |
Register for notifications of new program offerings.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewProgramOfferingsForProgram | ||
Description |
Registers for notification of new program offerings for
a program. | ||
Parameters | osid.id.Id | programId | the Id of the Program to monitor |
Errors | NULL_ARGUMENT | programId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewProgramOfferingsForTerm | ||
Description |
Registers for notification of new program offerings for
a term. | ||
Parameters | osid.id.Id | termId | the Id of the Term to monitor |
Errors | NULL_ARGUMENT | termId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedProgramOfferings | ||
Description |
Registers for notification of updated programs. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedProgramOfferingsForProgram | ||
Description |
Registers for notification of updated program offerings
for a program. | ||
Parameters | osid.id.Id | programId | the Id of the Program to monitor |
Errors | NULL_ARGUMENT | programId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedProgramOfferingsForTerm | ||
Description |
Registers for notification of updated program offerings
for a term. | ||
Parameters | osid.id.Id | termId | the Id of the Term to monitor |
Errors | NULL_ARGUMENT | termId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedProgramOffering | ||
Description |
Registers for notification of an updated program
offering. | ||
Parameters | osid.id.Id | programOfferingId | the Id of the ProgramOffering to monitor |
Errors | NULL_ARGUMENT | programOfferingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedProgramOfferings | ||
Description |
Registers for notification of deleted programs. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedProgramOfferingsForProgram | ||
Description |
Registers for notification of deleted program offerings
for a program. | ||
Parameters | osid.id.Id | programId | the Id of the Program to monitor |
Errors | NULL_ARGUMENT | programId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedProgramOfferingsForTerm | ||
Description |
Registers for notification of updated program offerings
for a term. | ||
Parameters | osid.id.Id | termId | the Id of the Term to monitor |
Errors | NULL_ARGUMENT | termId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedProgramOffering | ||
Description |
Registers for notification of a deleted program
offering. | ||
Parameters | osid.id.Id | programOfferingId | the Id of the ProgramOffering to monitor |
Errors | NULL_ARGUMENT | programOfferingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |