Interface | osid.course.syllabus.CourseSyllabusManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.course.syllabus.CourseSyllabusProfile | |||
Description |
The course syllabus manager provides access to syllabus sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
The course manager also provides a profile for determing the supported search types supported by this service. | ||
Method | getSyllabusLookupSession | ||
Description |
Gets the | ||
Return | osid.course.syllabus.SyllabusLookupSession | a SyllabusLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSyllabusLookup() is false | ||
Compliance | optional | This method must be implemented if supportsSyllabusLookup()
is true. | |
Method | getSyllabusLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.syllabus.SyllabusLookupSession | a SyllabusLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSyllabusLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSyllabusLookup()
and supportsVisibleFederation() are true | |
Method | getSyllabusQuerySession | ||
Description |
Gets the | ||
Return | osid.course.syllabus.SyllabusQuerySession | a SyllabusQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSyllabusQuery() is false | ||
Compliance | optional | This method must be implemented if supportsSyllabusQuery()
is true. | |
Method | getSyllabusQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.syllabus.SyllabusQuerySession | a SyllabusQuerySession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSyllabusQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSyllabusQuery()
and supportsVisibleFederation() are true | |
Method | getSyllabusSearchSession | ||
Description |
Gets the | ||
Return | osid.course.syllabus.SyllabusSearchSession | a SyllabusSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSyllabusSearch() is false | ||
Compliance | optional | This method must be implemented if supportsSyllabusSearch()
is true. | |
Method | getSyllabusSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.syllabus.SyllabusSearchSession | a SyllabusSearchSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSyllabusSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSyllabusSearch()
and supportsVisibleFederation() are true | |
Method | getSyllabusAdminSession | ||
Description |
Gets the | ||
Return | osid.course.syllabus.SyllabusAdminSession | a SyllabusAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSyllabusAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsSyllabusAdmin()
is true. | |
Method | getSyllabusAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.syllabus.SyllabusAdminSession | a SyllabusAdminSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSyllabusAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSyllabusAdmin()
and supportsVisibleFederation() are true | |
Method | getSyllabusNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.syllabus.SyllabusReceiver | syllabusReceiver | the receiver |
Return | osid.course.syllabus.SyllabusNotificationSession | a SyllabusNotificationSession | |
Errors | NULL_ARGUMENT | syllabusReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSyllabusNotification() is false | ||
Compliance | optional | This method must be implemented if supportsSyllabusNotification()
is true. | |
Method | getSyllabusNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.syllabus.SyllabusReceiver | syllabusReceiver | the receiver |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.syllabus.SyllabusNotificationSession | a SyllabusNotificationSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | syllabusReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSyllabusNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSyllabusNotification()
and supportsVisibleFederation() are true | |
Method | getSyllabusCourseCatalogSession | ||
Description |
Gets the session for retrieving syllabus to course catalog mappings. | ||
Return | osid.course.syllabus.SyllabusCourseCatalogSession | a SyllabusCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSyllabusCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsSyllabusCourseCatalog()
is true. | |
Method | getSyllabusCourseCatalogAssignmentSession | ||
Description |
Gets the session for assigning syllabus to course catalog mappings. | ||
Return | osid.course.syllabus.SyllabusCourseCatalogAssignmentSession | a SyllabusCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSyllabusCourseCatalogAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsSyllabusCourseCatalogAssignment() is true. | |
Method | getSyllabusSmartCourseCatalogSession | ||
Description |
Gets the session associated with the syllabus smart course catalog for the given course catalog. | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.syllabus.SyllabusSmartCourseCatalogSession | a SyllabusSmartCourseCatalogSession | |
Errors | NOT_FOUND | courseCatalogId not found | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSyllabusSmartCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if
supportsSyllabusSmartCourseCatalog() is true. | |
Method | getModuleLookupSession | ||
Description |
Gets the | ||
Return | osid.course.syllabus.ModuleLookupSession | a ModuleLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsModuleLookup() is false | ||
Compliance | optional | This method must be implemented if supportsModuleLookup() is
true. | |
Method | getModuleLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.syllabus.ModuleLookupSession | a ModuleLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsModuleLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsModuleLookup()
and supportsVisibleFederation() are true | |
Method | getModuleQuerySession | ||
Description |
Gets the | ||
Return | osid.course.syllabus.ModuleQuerySession | a ModuleQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsModuleQuery() is false | ||
Compliance | optional | This method must be implemented if supportsModuleQuery() is
true. | |
Method | getModuleQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.syllabus.ModuleQuerySession | a ModuleQuerySession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsModuleQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsModuleQuery() and
supportsVisibleFederation() are true | |
Method | getModuleSearchSession | ||
Description |
Gets the | ||
Return | osid.course.syllabus.ModuleSearchSession | a ModuleSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsModuleSearch() is false | ||
Compliance | optional | This method must be implemented if supportsModuleSearch() is
true. | |
Method | getModuleSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.syllabus.ModuleSearchSession | a ModuleSearchSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsModuleSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsModuleSearch()
and supportsVisibleFederation() are true | |
Method | getModuleAdminSession | ||
Description |
Gets the | ||
Return | osid.course.syllabus.ModuleAdminSession | a ModuleAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsModuleAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsModuleAdmin() is
true. | |
Method | getModuleAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.course.syllabus.ModuleAdminSession | a ModuleAdminSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsModuleAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsModuleAdmin() and
supportsVisibleFederation() are true | |
Method | getModuleNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.syllabus.ModuleReceiver | moduleReceiver | the receiver |
Return | osid.course.syllabus.ModuleNotificationSession | a ModuleNotificationSession | |
Errors | NULL_ARGUMENT | moduleReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsModuleNotification() is false | ||
Compliance | optional | This method must be implemented if supportsModuleNotification()
is true. | |
Method | getModuleNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.syllabus.ModuleReceiver | moduleReceiver | the receiver |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.syllabus.ModuleNotificationSession | a ModuleNotificationSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | moduleReceiver or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsModuleNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsModuleNotification()
and supportsVisibleFederation() are true | |
Method | getModuleCourseCatalogSession | ||
Description |
Gets the session for retrieving module to course catalog mappings. | ||
Return | osid.course.syllabus.ModuleCourseCatalogSession | a ModuleCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsModuleCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsModuleCourseCatalog()
is true. | |
Method | getModuleCourseCatalogAssignmentSession | ||
Description |
Gets the session for assigning module to course catalog mappings. | ||
Return | osid.course.syllabus.ModuleCourseCatalogAssignmentSession | a ModuleCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsModuleCourseCatalogAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsModuleCourseCatalogAssignment() is true. | |
Method | getModuleSmartCourseCatalogSession | ||
Description |
Gets the session associated with the module smart course catalog for the given course catalog. | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.syllabus.ModuleSmartCourseCatalogSession | a ModuleSmartCourseCatalogSession | |
Errors | NOT_FOUND | courseCatalogId not found | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsModuleSmartCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if
supportsModuleSmartCourseCatalog() is true. | |
Method | getDocetLookupSession | ||
Description |
Gets the | ||
Return | osid.course.syllabus.DocetLookupSession | a DocetLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDocetLookup() is false | ||
Compliance | optional | This method must be implemented if supportsDocetLookup() is
true. | |
Method | getDocetLookupSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the Docet |
Return | osid.course.syllabus.DocetLookupSession | a DocetLookupSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDocetLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsDocetLookup() and
supportsVisibleFederation() are true | |
Method | getDocetQuerySession | ||
Description |
Gets the | ||
Return | osid.course.syllabus.DocetQuerySession | a DocetQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDocetQuery() is false | ||
Compliance | optional | This method must be implemented if supportsDocetQuery() is
true. | |
Method | getDocetQuerySessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the Docet |
Return | osid.course.syllabus.DocetQuerySession | a DocetQuerySession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDocetQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsDocetQuery() and
supportsVisibleFederation() are true | |
Method | getDocetSearchSession | ||
Description |
Gets the | ||
Return | osid.course.syllabus.DocetSearchSession | a DocetSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDocetSearch() is false | ||
Compliance | optional | This method must be implemented if supportsDocetSearch() is
true. | |
Method | getDocetSearchSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the Docet |
Return | osid.course.syllabus.DocetSearchSession | a DocetSearchSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDocetSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsDocetSearch() and
supportsVisibleFederation() are true | |
Method | getDocetAdminSession | ||
Description |
Gets the | ||
Return | osid.course.syllabus.DocetAdminSession | a DocetAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDocetAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsDocetAdmin() is
true. | |
Method | getDocetAdminSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the Docet |
Return | osid.course.syllabus.DocetAdminSession | a DocetAdminSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDocetAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsDocetAdmin() and
supportsVisibleFederation() are true | |
Method | getDocetNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.course.syllabus.DocetReceiver | docetReceiver | the receiver |
Return | osid.course.syllabus.DocetNotificationSession | a DocetNotificationSession | |
Errors | NULL_ARGUMENT | docetReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDocetNotification() is false | ||
Compliance | optional | This method must be implemented if supportsDocetNotification()
is true. | |
Method | getDocetNotificationSessionForCourseCatalog | ||
Description |
Gets the | ||
Parameters | osid.course.syllabus.DocetReceiver | docetReceiver | the receiver |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Return | osid.course.syllabus.DocetNotificationSession | a DocetNotificationSession | |
Errors | NOT_FOUND | no CourseCatalog found by the given Id | |
NULL_ARGUMENT | docetReceiver is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDocetNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDocetNotification()
and supportsVisibleFederation() are true | |
Method | getDocetCourseCatalogSession | ||
Description |
Gets the session for retrieving docet to course catalog mappings. | ||
Return | osid.course.syllabus.DocetCourseCatalogSession | a DocetCourseCatalogSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDocetCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsDocetCourseCatalog()
is true. | |
Method | getDocetCourseCatalogAssignmentSession | ||
Description |
Gets the session for assigning docet to course catalog mappings. | ||
Return | osid.course.syllabus.DocetCourseCatalogAssignmentSession | a DocetCourseCatalogAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDocetCourseCatalogAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsDocetCourseCatalogAssignment() is true. | |
Method | getDocetSmartCourseCatalogSession | ||
Description |
Gets the session associated with the docet smart course catalog for the given course catalog. | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the course catalog |
Return | osid.course.syllabus.DocetSmartCourseCatalogSession | a DocetSmartCourseCatalogSession | |
Errors | NOT_FOUND | courseCatalogId not found | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDocetSmartCourseCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsDocetSmartCourseCatalog()
is true. | |
Method | getCourseSyllabusBatchManager | ||
Description |
Gets a | ||
Return | osid.course.syllabus.batch.CourseSyllabusBatchManager | a CourseSyllabusBatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCourseSyllabusBatch() is false | ||
Compliance | optional | This method must be implemented if supportsCourseSyllabusBatchj()
is true. |