Interface | osid.course.registration.CourseRegistrationManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.course.registration.CourseRegistrationProfile | |||
Description |
The course registration manager provides access to registration sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getActivityBundleLookupSession | ||
Description |
Gets the | ||
Return | osid.course.registration.ActivityBundleLookupSession | an ActivityBundleSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityBundleLookup() is false | ||
Compliance | optional | This method must be implemented if supportsActivityBundleLookup()
is true. | |
Method | getActivityBundleLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.registration.ActivityBundleLookupSession | an ActivityBundleLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityBundleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityBundleLookup()
and supportsVisibleFederation() are true | |
Method | getActivityBundleQuerySession | ||
Description |
Gets the | ||
Return | osid.course.registration.ActivityBundleQuerySession | an ActivityBundleQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityBundleQuery() is false | ||
Compliance | optional | This method must be implemented if supportsActivityBundleQuery()
is true. | |
Method | getActivityBundleQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.registration.ActivityBundleQuerySession | an ActivityBundleQuerySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityBundleQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityBundleQuery()
and supportsVisibleFederation() are true | |
Method | getActivityBundleSearchSession | ||
Description |
Gets the | ||
Return | osid.course.registration.ActivityBundleSearchSession | an ActivityBundleSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityBundleSearch() is false | ||
Compliance | optional | This method must be implemented if supportsActivityBundleSearch()
is true. | |
Method | getActivityBundleSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.registration.ActivityBundleSearchSession | an ActivityBundleSearchSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityBundleSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityBundleSearch()
and supportsVisibleFederation() are true | |
Method | getActivityBundleAdminSession | ||
Description |
Gets the | ||
Return | osid.course.registration.ActivityBundleAdminSession | an ActivityBundleAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityBundleAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsActivityBundleAdmin()
is true. | |
Method | getActivityBundleAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.registration.ActivityBundleAdminSession | an ActivityBundleAdminSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityBundleAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityBundleAdmin()
and supportsVisibleFederation() are true | |
Method | getActivityBundleNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.registration.ActivityBundleReceiver | activityBundleReceiver | the notification callback |
Return | osid.course.registration.ActivityBundleNotificationSession | an ActivityBundleNotificationSession | |
Errors | NULL_ARGUMENT | activityBundleReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityBundleNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityBundleNotification() is true. | |
Method | getActivityBundleNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.registration.ActivityBundleReceiver | activityBundleReceiver | the notification callback |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.registration.ActivityBundleNotificationSession | an ActivityBundleNotificationSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | activityBundleReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityBundleNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityBundleNotification() and
supportsVisibleFederation() are true | |
Method | getActivityBundleCourseCatalogSession | ||
Description |
Gets the | ||
Return | osid.course.registration.ActivityBundleCourseCatalogSession | an ActivityBundleCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityBundleCourseCatalog() is false
| ||
Compliance | optional | This method must be implemented if
supportsActivityBundleCourseCatalog() is true. | |
Method | getActivityBundleCourseCatalogAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.registration.ActivityBundleCourseCatalogAssignmentSession | an ActivityBundleCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityBundleCourseCatalogAssignment() is
false | ||
Compliance | optional | This method must be implemented if
supportsActivityBundleCourseCatalogAssignment() is true.
| |
Method | getActivityBundleSmartCourseCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.registration.ActivityBundleSmartCourseCatalogSession | an ActivityBundleSmartCourseCatalogSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityBundleSmartCourseCatalog() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityBundleSmartCourseCatalog() and
supportsVisibleFederation() are true | |
Method | getRegistrationLookupSession | ||
Description |
Gets the | ||
Return | osid.course.registration.RegistrationLookupSession | a RegistrationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRegistrationLookup() is false | ||
Compliance | optional | This method must be implemented if supportsRegistrationLookup()
is true. | |
Method | getRegistrationLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.registration.RegistrationLookupSession | a RegistrationLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRegistrationLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRegistrationLookup()
and supportsVisibleFederation() are true | |
Method | getRegistrationQuerySession | ||
Description |
Gets the | ||
Return | osid.course.registration.RegistrationQuerySession | a RegistrationQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRegistrationQuery() is false | ||
Compliance | optional | This method must be implemented if supportsRegistrationQuery()
is true. | |
Method | getRegistrationQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.registration.RegistrationQuerySession | a RegistrationQuerySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRegistrationQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRegistrationQuery()
and supportsVisibleFederation() are true | |
Method | getRegistrationSearchSession | ||
Description |
Gets the | ||
Return | osid.course.registration.RegistrationSearchSession | a RegistrationSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRegistrationSearch() is false | ||
Compliance | optional | This method must be implemented if supportsRegistrationSearch()
is true. | |
Method | getRegistrationSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.registration.RegistrationSearchSession | a RegistrationSearchSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRegistrationSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRegistrationSearch()
and supportsVisibleFederation() are true | |
Method | getRegistrationAdminSession | ||
Description |
Gets the | ||
Return | osid.course.registration.RegistrationAdminSession | a RegistrationAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRegistrationAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRegistrationAdmin()
is true. | |
Method | getRegistrationAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.registration.RegistrationAdminSession | a RegistrationAdminSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRegistrationAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRegistrationAdmin()
and supportsVisibleFederation() are true | |
Method | getRegistrationNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.registration.RegistrationReceiver | registrationReceiver | the notification callback |
Return | osid.course.registration.RegistrationNotificationSession | a RegistrationNotificationSession | |
Errors | NULL_ARGUMENT | registrationReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRegistrationNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsRegistrationNotification() is true. | |
Method | getRegistrationNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.registration.RegistrationReceiver | registrationReceiver | the notification callback |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.registration.RegistrationNotificationSession | a RegistrationNotificationSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | registrationReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRegistrationNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsRegistrationNotification() and
supportsVisibleFederation() are true | |
Method | getRegistrationCourseCatalogSession | ||
Description |
Gets the | ||
Return | osid.course.registration.RegistrationCourseCatalogSession | a RegistrationCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRegistrationCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if
supportsRegistrationCourseCatalog() is true. | |
Method | getRegistrationCourseCatalogAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.registration.RegistrationCourseCatalogAssignmentSession | a RegistrationCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRegistrationCourseCatalogAssignment() is
false | ||
Compliance | optional | This method must be implemented if
supportsRegistrationCourseCatalogAssignment() is true. | |
Method | getRegistrationSmartCourseCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.registration.RegistrationSmartCourseCatalogSession | a RegistrationSmartCourseCatalogSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRegistrationSmartCourseCatalog() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsRegistrationSmartCourseCatalog() and
supportsVisibleFederation() are true | |
Method | getActivityRegistrationLookupSession | ||
Description |
Gets the | ||
Return | osid.course.registration.ActivityRegistrationLookupSession | an ActivityRegistrationSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityRegistrationLookup() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityRegistrationLookup() is true. | |
Method | getActivityRegistrationLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.registration.ActivityRegistrationLookupSession | an ActivityRegistrationLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityRegistrationLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityRegistrationLookup() and
supportsVisibleFederation() are true | |
Method | getActivityRegistrationQuerySession | ||
Description |
Gets the | ||
Return | osid.course.registration.ActivityRegistrationQuerySession | an ActivityRegistrationQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityRegistrationQuery() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityRegistrationQuery() is true. | |
Method | getActivityRegistrationQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.registration.ActivityRegistrationQuerySession | an ActivityRegistrationQuerySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityRegistrationQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityRegistrationQuery() and
supportsVisibleFederation() are true | |
Method | getActivityRegistrationSearchSession | ||
Description |
Gets the | ||
Return | osid.course.registration.ActivityRegistrationSearchSession | an ActivityRegistrationSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityRegistrationSearch() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityRegistrationSearch() is true. | |
Method | getActivityRegistrationSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.registration.ActivityRegistrationSearchSession | an ActivityRegistrationSearchSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityRegistrationSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityRegistrationSearch() and
supportsVisibleFederation() are true | |
Method | getActivityRegistrationAdminSession | ||
Description |
Gets the | ||
Return | osid.course.registration.ActivityRegistrationAdminSession | an ActivityRegistrationAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityRegistrationAdmin() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityRegistrationAdmin() is true. | |
Method | getActivityRegistrationAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.registration.ActivityRegistrationAdminSession | an ActivityRegistrationAdminSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityRegistrationAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityRegistrationAdmin() and
supportsVisibleFederation() are true | |
Method | getActivityRegistrationNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.registration.ActivityRegistrationReceiver | activityRegistrationReceiver | the notification callback |
Return | osid.course.registration.ActivityRegistrationNotificationSession | an ActivityRegistrationNotificationSession | |
Errors | NULL_ARGUMENT | activityRegistrationReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityRegistrationNotification() is false
| ||
Compliance | optional | This method must be implemented if
supportsActivityRegistrationNotification() is true. | |
Method | getActivityRegistrationNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.registration.ActivityRegistrationReceiver | activityRegistrationReceiver | the notification callback |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.registration.ActivityRegistrationNotificationSession | an ActivityRegistrationNotificationSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | activityRegistrationReceiver or courseCatalogId
is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityRegistrationNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityRegistrationNotification() and
supportsVisibleFederation() are true | |
Method | getActivityRegistrationCourseCatalogSession | ||
Description |
Gets the | ||
Return | osid.course.registration.ActivityRegistrationCourseCatalogSession | an ActivityRegistrationCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityRegistrationCourseCatalog() is false
| ||
Compliance | optional | This method must be implemented if
supportsActivityRegistrationCourseCatalog() is true. | |
Method | getActivityRegistrationCourseCatalogAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.registration.ActivityRegistrationCourseCatalogAssignmentSession | an ActivityRegistrationCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityRegistrationCourseCatalogAssignment() is
false | ||
Compliance | optional | This method must be implemented if
supportsActivityRegistrationCourseCatalogAssignment() is true.
| |
Method | getActivityRegistrationSmartCourseCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.registration.ActivityRegistrationSmartCourseCatalogSession | an ActivityRegistrationSmartCourseCatalogSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityRegistrationSmartCourseCatalog() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityRegistrationSmartCourseCatalog() and
supportsVisibleFederation() are true | |
Method | getCourseRegistrationBatchManager | ||
Description |
Gets a | ||
Return | osid.course.registration.batch.CourseRegistrationBatchManager | a CourseRegistrationBatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseRegistrationBatch() is false | ||
Compliance | optional | This method must be implemented if
supportsACourseRegistrationBatch() is true. |