Interface | osid.course.requisite.CourseRequisiteManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.course.requisite.CourseRequisiteProfile | |||
Description |
The course requisite manager provides access to course requisite sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getRequisiteLookupSession | ||
Description |
Gets the | ||
Return | osid.course.requisite.RequisiteLookupSession | a RequisiteLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRequisiteLookup() is false | ||
Compliance | optional | This method must be implemented if supportsRequisiteLookup()
is true. | |
Method | getRequisiteLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.requisite.RequisiteLookupSession | a RequisiteLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequisiteLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRequisiteLookup()
and supportsVisibleFederation() are true | |
Method | getRequisiteQuerySession | ||
Description |
Gets the | ||
Return | osid.course.requisite.RequisiteQuerySession | a RequisiteQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRequisiteQuery() is false | ||
Compliance | optional | This method must be implemented if supportsRequisiteQuery()
is true. | |
Method | getRequisiteQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.requisite.RequisiteQuerySession | a RequisiteQuerySession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequisiteQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRequisiteQuery()
and supportsVisibleFederation() are true | |
Method | getRequisiteSearchSession | ||
Description |
Gets the | ||
Return | osid.course.requisite.RequisiteSearchSession | a RequisiteSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRequisiteSearch() is false | ||
Compliance | optional | This method must be implemented if supportsRequisiteSearch()
is true. | |
Method | getRequisiteSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.requisite.RequisiteSearchSession | a RequisiteSearchSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequisiteSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRequisiteSearch()
and supportsVisibleFederation() are true | |
Method | getRequisiteAdminSession | ||
Description |
Gets the | ||
Return | osid.course.requisite.RequisiteAdminSession | a RequisiteAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRequisiteAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRequisiteAdmin()
is true. | |
Method | getRequisiteAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.requisite.RequisiteAdminSession | a RequisiteAdminSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequisiteAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRequisiteAdmin()
and supportsVisibleFederation() are true | |
Method | getRequisiteNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.requisite.RequisiteReceiver | requisiteReceiver | the notification callback |
Return | osid.course.requisite.RequisiteNotificationSession | a RequisiteNotificationSession | |
Errors | NULL_ARGUMENT | requisiteReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequisiteNotification() is false | ||
Compliance | optional | This method must be implemented if supportsRequisiteNotification()
is true. | |
Method | getRequisiteNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.requisite.RequisiteReceiver | requisiteReceiver | the notification callback |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.requisite.RequisiteNotificationSession | a RequisiteNotificationSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | requisiteReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequisiteNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRequisiteNotification()
and supportsVisibleFederation() are true | |
Method | getRequisiteCourseCatalogSession | ||
Description |
Gets the | ||
Return | osid.course.requisite.RequisiteCourseCatalogSession | a RequisiteCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRequisiteCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsRequisiteCourseCatalog()
is true. | |
Method | getRequisiteCourseCatalogAssignmentSession | ||
Description |
Gets the | ||
Return | osid.course.requisite.RequisiteCourseCatalogAssignmentSession | a RequisiteCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRequisiteCourseCatalogAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsRequisiteCourseCatalogAssignment() is true. | |
Method | getRequisiteSmartCourseCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.requisite.RequisiteSmartCourseCatalogSession | a RequisiteSmartCourseCatalogSession | |
Errors | NOT_FOUND | no course catalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRequisiteSmartCourseCatalog() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsRequisiteSmartCourseCatalog() and
supportsVisibleFederation() are true |