Interface | osid.course.registration.ActivityRegistrationNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The 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 | canRegisterForActivityRegistrationNotifications | ||
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 activity registrations 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 | reliableActivityRegistrationNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableActivityRegistrationNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeActivityRegistrationNotification | ||
Description |
Acknowledge an activity registration 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 | registerForNewActivityRegistrations | ||
Description |
Register for notifications of new activity
registrations. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewActivityRegistrationsForRegistration | ||
Description |
Register for notifications of new registrations for the
given registration. | ||
Parameters | osid.id.Id | registrationId | the Id of the Registration to monitor |
Errors | NULL_ARGUMENT | registrationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewActivityRegistrationsForActivity | ||
Description |
Register for notifications of new registrations for the
given activity. | ||
Parameters | osid.id.Id | activityId | the Id of the Activity to monitor |
Errors | NULL_ARGUMENT | activityId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewActivityRegistrationsForStudent | ||
Description |
Register for notifications of new registrations for the
given student. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedActivityRegistrations | ||
Description |
Registers for notification of updated activity
registrations. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedActivityRegistrationsForRegistration | ||
Description |
Registers for notification of updated activity
registrations for the given registration. | ||
Parameters | osid.id.Id | registrationId | the Id of the Regitsration to monitor |
Errors | NULL_ARGUMENT | registrationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedActivityRegistrationsForActivity | ||
Description |
Registers for notification of updated activity
registrations for the given activity. | ||
Parameters | osid.id.Id | activityId | the Id of the Activity to monitor |
Errors | NULL_ARGUMENT | activityId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedActivityRegistrationsForStudent | ||
Description |
Registers for notification of updated activity
registrations for the given student. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedActivityRegistration | ||
Description |
Registers for notification of an updated activity
registration. | ||
Parameters | osid.id.Id | activityRegistrationId | the Id of the ActivityRegistration to monitor |
Errors | NULL_ARGUMENT | activityRegistrationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedActivityRegistrations | ||
Description |
Registers for notification of deleted activity
registrations. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedActivityRegistrationsForRegistration | ||
Description |
Registers for notification of deleted activity
registrations for the given registration. | ||
Parameters | osid.id.Id | registrationId | the Id of the Registration to monitor |
Errors | NULL_ARGUMENT | registrationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedActivityRegistrationsForActivity | ||
Description |
Registers for notification of deleted activity
registrations for the given activity. | ||
Parameters | osid.id.Id | activityId | the Id of the Activity to monitor |
Errors | NULL_ARGUMENT | activityId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedActivityRegistrationsForStudent | ||
Description |
Registers for notification of deleted activity
registrations for the given student. | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedActivityRegistration | ||
Description |
Registers for notification of a deleted activity
registration. | ||
Parameters | osid.id.Id | activityRegistrationId | the Id of the ActivityRegistration to monitor |
Errors | NULL_ARGUMENT | activityRegistrationId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |