Interface | osid.course.CourseManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.course.CourseProfile | |||
Description |
The course manager provides access to course management sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getCourseLookupSession | ||
Description |
Gets the | ||
Return | osid.course.CourseLookupSession | a CourseLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCourseLookup() is
true. | |
Method | getCourseLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.CourseLookupSession | a CourseLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsCourseLookup()
and supportsVisibleFederation() are true | |
Method | getCourseQuerySession | ||
Description |
Gets the | ||
Return | osid.course.CourseQuerySession | a CourseQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCourseQuery() is
true. | |
Method | getCourseQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.CourseQuerySession | a CourseQuerySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsCourseQuery() and
supportsVisibleFederation() are true | |
Method | getCourseSearchSession | ||
Description |
Gets the | ||
Return | osid.course.CourseSearchSession | a CourseSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCourseSearch() is
true. | |
Method | getCourseSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.CourseSearchSession | a CourseSearchSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsCourseSearch()
and supportsVisibleFederation() are true | |
Method | getCourseAdminSession | ||
Description |
Gets the | ||
Return | osid.course.CourseAdminSession | a CourseAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCourseAdmin() is
true. | |
Method | getCourseAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.CourseAdminSession | a CourseAdminSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsCourseAdmin() and
supportsVisibleFederation() are true | |
Method | getCourseNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.CourseReceiver | courseReceiver | the notification callback |
Return | osid.course.CourseNotificationSession | a CourseNotificationSession | |
Errors | NULL_ARGUMENT | courseReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseNotification() is false | ||
Compliance | optional | This method must be implemented if supportsCourseNotification()
is true. | |
Method | getCourseNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.CourseReceiver | courseReceiver | the notification callback |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.CourseNotificationSession | a CourseNotificationSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCourseNotification()
and supportsVisibleFederation() are true | |
Method | getCourseCourseCatalogSession | ||
Description |
Gets the | ||
Return | osid.course.CourseCourseCatalogSession | a CourseCourseCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsCourseCourseCatalog()
is true. | |
Method | getCourseCourseCatalogAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.CourseCourseCatalogAssignmentSession | a CourseCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseCourseCatalogAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsCourseCourseCatalogAssignment() is true. | |
Method | getCourseSmartCourseCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.CourseSmartCourseCatalogSession | a CourseSmartCourseCatalogSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseSmartCourseCatalog() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsCourseSmartCourseCatalog() and
supportsVisibleFederation() are true | |
Method | getActivityUnitLookupSession | ||
Description |
Gets the | ||
Return | osid.course.ActivityUnitLookupSession | an ActivityUnitSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityUnitLookup() is false | ||
Compliance | optional | This method must be implemented if supportsActivityUnitLookup()
is true. | |
Method | getActivityUnitLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.ActivityUnitLookupSession | an ActivityUnitLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityUnitLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityUnitLookup()
and supportsVisibleFederation() are true | |
Method | getActivityUnitQuerySession | ||
Description |
Gets the | ||
Return | osid.course.ActivityUnitQuerySession | an ActivityUnitQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityUnitQuery() is false | ||
Compliance | optional | This method must be implemented if supportsActivityUnitQuery()
is true. | |
Method | getActivityUnitQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.ActivityUnitQuerySession | an ActivityUnitQuerySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityUnitQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityUnitQuery()
and supportsVisibleFederation() are true | |
Method | getActivityUnitSearchSession | ||
Description |
Gets the | ||
Return | osid.course.ActivityUnitSearchSession | an ActivityUnitSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityUnitSearch() is false | ||
Compliance | optional | This method must be implemented if supportsActivityUnitSearch()
is true. | |
Method | getActivityUnitSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.ActivityUnitSearchSession | an ActivityUnitSearchSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityUnitSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityUnitSearch()
and supportsVisibleFederation() are true | |
Method | getActivityUnitAdminSession | ||
Description |
Gets the | ||
Return | osid.course.ActivityUnitAdminSession | an ActivityUnitAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityUnitAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsActivityUnitAdmin()
is true. | |
Method | getActivityUnitAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.ActivityUnitAdminSession | an ActivityUnitAdminSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityUnitAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityUnitAdmin()
and supportsVisibleFederation() are true | |
Method | getActivityUnitNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.ActivityUnitReceiver | activityUnitReceiver | the notification callback |
Return | osid.course.ActivityUnitNotificationSession | an ActivityUnitNotificationSession | |
Errors | NULL_ARGUMENT | activityUnitReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityUnitNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityUnitNotification() is true. | |
Method | getActivityUnitNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.ActivityUnitReceiver | activityUnitReceiver | the notification callback |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.ActivityUnitNotificationSession | an ActivityUnitNotificationSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | activityUnitReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityUnitNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityUnitNotification() and
supportsVisibleFederation() are true | |
Method | getActivityUnitCourseCatalogSession | ||
Description |
Gets the | ||
Return | osid.course.ActivityUnitCourseCatalogSession | an ActivityUnitCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityUnitCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityUnitCourseCatalog() is true. | |
Method | getActivityUnitCourseCatalogAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.ActivityUnitCourseCatalogAssignmentSession | an ActivityUnitCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityUnitCourseCatalogAssignment() is
false | ||
Compliance | optional | This method must be implemented if
supportsActivityUnitCourseCatalogAssignment() is true. | |
Method | getActivityUnitSmartCourseCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.ActivityUnitSmartCourseCatalogSession | an ActivityUnitSmartCourseCatalogSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityUnitSmartCourseCatalog() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsActivityUnitSmartCourseCatalog() and
supportsVisibleFederation() are true | |
Method | getCourseOfferingLookupSession | ||
Description |
Gets the | ||
Return | osid.course.CourseOfferingLookupSession | a CourseOfferingSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseOfferingLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCourseOfferingLookup()
is true. | |
Method | getCourseOfferingLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.CourseOfferingLookupSession | a CourseOfferingLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseOfferingLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCourseOfferingLookup()
and supportsVisibleFederation() are true | |
Method | getCourseOfferingQuerySession | ||
Description |
Gets the | ||
Return | osid.course.CourseOfferingQuerySession | a CourseOfferingQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseOfferingQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCourseOfferingQuery()
is true. | |
Method | getCourseOfferingQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.CourseOfferingQuerySession | a CourseOfferingQuerySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseOfferingQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCourseOfferingQuery()
and supportsVisibleFederation() are true | |
Method | getCourseOfferingSearchSession | ||
Description |
Gets the | ||
Return | osid.course.CourseOfferingSearchSession | a CourseOfferingSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseOfferingSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCourseOfferingSearch()
is true. | |
Method | getCourseOfferingSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.CourseOfferingSearchSession | a CourseOfferingSearchSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseOfferingSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCourseOfferingSearch()
and supportsVisibleFederation() are true | |
Method | getCourseOfferingAdminSession | ||
Description |
Gets the | ||
Return | osid.course.CourseOfferingAdminSession | a CourseOfferingAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseOfferingAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCourseOfferingAdmin()
is true. | |
Method | getCourseOfferingAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.CourseOfferingAdminSession | a CourseOfferingAdminSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseOfferingAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCourseOfferingAdmin()
and supportsVisibleFederation() are true | |
Method | getCourseOfferingNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.CourseOfferingReceiver | courseOfferingReceiver | the notification callback |
Return | osid.course.CourseOfferingNotificationSession | a CourseOfferingNotificationSession | |
Errors | NULL_ARGUMENT | courseOfferingReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseOfferingNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsCourseOfferingNotification() is true. | |
Method | getCourseOfferingNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.CourseOfferingReceiver | courseOfferingReceiver | the notification callback |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.CourseOfferingNotificationSession | a CourseOfferingNotificationSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseOfferingReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseOfferingNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsCourseOfferingNotification() and
supportsVisibleFederation() are true | |
Method | getCourseOfferingCourseCatalogSession | ||
Description |
Gets the | ||
Return | osid.course.CourseOfferingCourseCatalogSession | a CourseOfferingCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseOfferingCourseCatalog() is false
| ||
Compliance | optional | This method must be implemented if
supportsCourseOfferingCourseCatalog() is true. | |
Method | getCourseOfferingCourseCatalogAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.CourseOfferingCourseCatalogAssignmentSession | a CourseOfferingCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseOfferingCourseCatalogAssignment() is
false | ||
Compliance | optional | This method must be implemented if
supportsCourseOfferingCourseCatalogAssignment() is true.
| |
Method | getCourseOfferingSmartCourseCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.CourseOfferingSmartCourseCatalogSession | a CourseOfferingSmartCourseCatalogSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseOfferingSmartCourseCatalog() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsCourseOfferingSmartCourseCatalog() and
supportsVisibleFederation() are true | |
Method | getActivityLookupSession | ||
Description |
Gets the | ||
Return | osid.course.ActivityLookupSession | an ActivityLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityLookup() is false | ||
Compliance | optional | This method must be implemented if supportsActivityLookup()
is true. | |
Method | getActivityLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.ActivityLookupSession | an ActivityLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityLookup()
and supportsVisibleFederation() are true | |
Method | getActivityQuerySession | ||
Description |
Gets the | ||
Return | osid.course.ActivityQuerySession | an ActivityQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityQuery() is false | ||
Compliance | optional | This method must be implemented if supportsActivityQuery()
is true. | |
Method | getActivityQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.ActivityQuerySession | an ActivityQuerySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityQuery()
and supportsVisibleFederation() are true | |
Method | getActivitySearchSession | ||
Description |
Gets the | ||
Return | osid.course.ActivitySearchSession | an ActivitySearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivitySearch() is false | ||
Compliance | optional | This method must be implemented if supportsActivitySearch()
is true. | |
Method | getActivitySearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.ActivitySearchSession | an ActivitySearchSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivitySearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivitySearch()
and supportsVisibleFederation() are true | |
Method | getActivityAdminSession | ||
Description |
Gets the | ||
Return | osid.course.ActivityAdminSession | an ActivityAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsActivityAdmin()
is true. | |
Method | getActivityAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.ActivityAdminSession | an ActivityAdminSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityAdmin()
and supportsVisibleFederation() are true | |
Method | getActivityNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.ActivityReceiver | activityReceiver | the notification callback |
Return | osid.course.ActivityNotificationSession | an ActivityNotificationSession | |
Errors | NULL_ARGUMENT | activityReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityNotification() is false | ||
Compliance | optional | This method must be implemented if supportsActivityNotification()
is true. | |
Method | getActivityNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.ActivityReceiver | activityReceiver | the notification callback |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.ActivityNotificationSession | an ActivityNotificationSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | activityReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityNotification()
and supportsVisibleFederation() are true | |
Method | getActivityCourseCatalogSession | ||
Description |
Gets the | ||
Return | osid.course.ActivityCourseCatalogSession | an ActivityCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsActivityCourseCatalog()
is true. | |
Method | getActivityCourseCatalogAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.ActivityCourseCatalogAssignmentSession | an ActivityCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityCourseCatalogAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsActivityCourseCatalogAssignment() is true. | |
Method | getActivitySmartCourseCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.ActivitySmartCourseCatalogSession | an ActivitySmartCourseCatalogSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivitySmartCourseCatalog() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsActivitySmartCourseCatalog() and
supportsVisibleFederation() are true | |
Method | getActivityUnravellingSession | ||
Description |
Gets the | ||
Return | osid.course.ActivityUnravellingSession | an ActivityUnravellingSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsActivityUnravelling() is false | ||
Compliance | optional | This method must be implemented if supportsActivityUnravelling()
is true. | |
Method | getActivityUnravellingSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.ActivityUnravellingSession | an ActivityUnravellingSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsActivityUnravelling() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsActivityUnravelling()
and supportsVisibleFederation() are true | |
Method | getTermLookupSession | ||
Description |
Gets the | ||
Return | osid.course.TermLookupSession | a TermLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTermLookup() is false | ||
Compliance | optional | This method must be implemented if supportsTermLookup() is
true. | |
Method | getTermLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.TermLookupSession | a TermLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTermLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsTermLookup() and
supportsVisibleFederation() are true | |
Method | getTermQuerySession | ||
Description |
Gets the | ||
Return | osid.course.TermQuerySession | a TermQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTermQuery() is false | ||
Compliance | optional | This method must be implemented if supportsTermQuery() is
true. | |
Method | getTermQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.TermQuerySession | a TermQuerySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTermQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsTermQuery() and
supportsVisibleFederation() are true | |
Method | getTermSearchSession | ||
Description |
Gets the | ||
Return | osid.course.TermSearchSession | a TermSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTermSearch() is false | ||
Compliance | optional | This method must be implemented if supportsTermSearch() is
true. | |
Method | getTermSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.TermSearchSession | a TermSearchSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTermSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsTermSearch() and
supportsVisibleFederation() are true | |
Method | getTermAdminSession | ||
Description |
Gets the | ||
Return | osid.course.TermAdminSession | a TermAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTermAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsTermAdmin() is
true. | |
Method | getTermAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.TermAdminSession | a TermAdminSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTermAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsTermAdmin() and
supportsVisibleFederation() are true | |
Method | getTermNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.TermReceiver | termReceiver | the notification callback |
Return | osid.course.TermNotificationSession | a TermNotificationSession | |
Errors | NULL_ARGUMENT | termReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTermNotification() is false | ||
Compliance | optional | This method must be implemented if supportsTermNotification()
is true. | |
Method | getTermNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.TermReceiver | termReceiver | the notification callback |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.TermNotificationSession | a TermNotificationSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | termReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTermNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTermNotification()
and supportsVisibleFederation() are true | |
Method | getTermHierarchySession | ||
Description |
Gets the term hierarchy traversal session. | ||
Return | osid.course.TermHierarchySession | a TermHierarchySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTermHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsTermHierarchy()
is true. | |
Method | getTermHierarchySessionForCourseCatalog | ||
Description |
Gets the term hierarchy traversal session for the given course catalog. | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.TermHierarchySession | a TermHierarchySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTermHierarchy() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTermHierarchy()
and supportsVisibleFederation() are true | |
Method | getTermHierarchyDesignSession | ||
Description |
Gets the term hierarchy design session. | ||
Return | osid.course.TermHierarchyDesignSession | a TermHierarchyDesignSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTermHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsTermHierarchyDesign()
is true. | |
Method | getTermHierarchyDesignSessionForCourseCatalog | ||
Description |
Gets the term hierarchy design session for the given course catalog. | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.TermHierarchyDesignSession | a TermHierarchyDesignSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTermHierarchyDesign() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTermHierarchyDesign()
and supportsVisibleFederation() are true | |
Method | getTermCourseCatalogSession | ||
Description |
Gets the | ||
Return | osid.course.TermCourseCatalogSession | a TermCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTermCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsTermCourseCatalog()
is true. | |
Method | getTermCourseCatalogAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.TermCourseCatalogAssignmentSession | a TermCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTermCourseCatalogAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsTermCourseCatalogAssignment() is true. | |
Method | getTermSmartCourseCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.TermSmartCourseCatalogSession | a TermSmartCourseCatalogSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsTermSmartCourseCatalog() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsTermSmartCourseCatalog()
and supportsVisibleFederation() are true | |
Method | getCourseCatalogLookupSession | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalogLookupSession | a CourseCatalogLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseCatalogLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCourseCatalogLookup()
is true. | |
Method | getCourseCatalogQuerySession | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalogQuerySession | a CourseCatalogQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseCatalogQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCourseCatalogQuery()
is true. | |
Method | getCourseCatalogSearchSession | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalogSearchSession | a CourseCatalogSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseCatalogSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCourseCatalogSearch()
is true. | |
Method | getCourseCatalogAdminSession | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalogAdminSession | a CourseCatalogAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseCatalogAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCourseCatalogAdmin()
is true. | |
Method | getCourseCatalogNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.CourseCatalogReceiver | courseCatalogReceiver | the notification callback |
Return | osid.course.CourseCatalogNotificationSession | a CourseCatalogNotificationSession | |
Errors | NULL_ARGUMENT | courseCatalogReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCourseCatalogNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsCourseCatalogNotification() is true. | |
Method | getCourseCatalogHierarchySession | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalogHierarchySession | a CourseCatalogHierarchySession for course catalogs | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseCatalogHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsCourseCatalogHierarchy()
is true. | |
Method | getCourseCatalogHierarchyDesignSession | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalogHierarchyDesignSession | a HierarchyDesignSession for course catalogs | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseCatalogHierarchyDesign() is false
| ||
Compliance | optional | This method must be implemented if
supportsCourseCatalogHierarchyDesign() is true. | |
Method | getCourseBatchManager | ||
Description |
Gets a | ||
Return | osid.course.batch.CourseBatchManager | a CourseBatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseBatch() is false | ||
Compliance | optional | This method must be implemented if supportsCourseBatch() is
true. | |
Method | getCourseProgramManager | ||
Description |
Gets a | ||
Return | osid.course.program.CourseProgramManager | a CourseProgramManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseProgram() is false | ||
Compliance | optional | This method must be implemented if supportsCourseProgram()
is true. | |
Method | getCourseRegistrationManager | ||
Description |
Gets a | ||
Return | osid.course.registration.CourseRegistrationManager | a CourseRegistrationManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseRegistration() is false | ||
Compliance | optional | This method must be implemented if supportsCourseRegistration()
is true. | |
Method | getCourseRequisiteManager | ||
Description |
Gets a | ||
Return | osid.course.requisite.CourseRequisiteManager | a CourseRequisiteManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseRequisite() is false | ||
Compliance | optional | This method must be implemented if supportsCourseRequisite()
is true. | |
Method | getCourseSyllabusManager | ||
Description |
Gets a | ||
Return | osid.course.syllabus.CourseSyllabusManager | a CourseSyllabusManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseSyllabus() is false | ||
Compliance | optional | This method must be implemented if supportsCourseSyllabus()
is true. | |
Method | getCoursePlanManager | ||
Description |
Gets a | ||
Return | osid.course.plan.CoursePlanManager | a CoursePlanManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCoursePlan() is false | ||
Compliance | optional | This method must be implemented if supportsCoursePlan() is
true. | |
Method | getCourseChronicleManager | ||
Description |
Gets a | ||
Return | osid.course.chronicle.CourseChronicleManager | a CourseChronicleManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseChronicle() is false | ||
Compliance | optional | This method must be implemented if supportsCourseChronicle()
is true. |