OSID Specifications
course syllabus package
Version 3.0.0
course syllabus package
Version 3.0.0
| Interface | osid.course.syllabus.CourseSyllabusProfile | ||
|---|---|---|---|
| Implements | osid.OsidProfile | ||
| Implemented By | osid.course.syllabus.CourseSyllabusManager | ||
osid.course.syllabus.CourseSyllabusProxyManager | |||
| Description |
The course profile describes the interoperability among course services. | ||
| Method | supportsVisibleFederation | ||
| Description |
Tests if any docet federation is exposed. Federation is exposed when a specific docet may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of docetsappears as a single docet. | ||
| Return | boolean | true if visible federation is supproted, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSyllabusLookup | ||
| Description |
Tests for the availability of a syllabus lookup service. | ||
| Return | boolean | true if syllabus lookup is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSyllabusQuery | ||
| Description |
Tests if querying syllabi is available. | ||
| Return | boolean | true if syllabus query is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSyllabusSearch | ||
| Description |
Tests if searching for syllabi is available. | ||
| Return | boolean | true if syllabus search is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSyllabusAdmin | ||
| Description |
Tests if searching for syllabi is available. | ||
| Return | boolean | true if syllabus search is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSyllabusNotification | ||
| Description |
Tests if syllabus notification is available. | ||
| Return | boolean | true if syllabus notification is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSyllabusCourseCatalog | ||
| Description |
Tests if a syllabus to course catalog lookup session is available. | ||
| Return | boolean | true if syllabus course catalog lookup session is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSyllabusCourseCatalogAssignment | ||
| Description |
Tests if a syllabus to course catalog assignment session is available. | ||
| Return | boolean | true if syllabus course catalog assignment is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSyllabusSmartCourseCatalog | ||
| Description |
Tests if a syllabus smart course catalog session is available. | ||
| Return | boolean | true if syllabus smart course catalog is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsModule | ||
| Description |
Tests for the availability of a module service for getting available modules for a resource. | ||
| Return | boolean | true if module is available, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsModuleLookup | ||
| Description |
Tests for the availability of a module lookup service. | ||
| Return | boolean | true if module lookup is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsModuleQuery | ||
| Description |
Tests if querying modules is available. | ||
| Return | boolean | true if module query is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsModuleSearch | ||
| Description |
Tests if searching for modules is available. | ||
| Return | boolean | true if module search is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsModuleAdmin | ||
| Description |
Tests if searching for modules is available. | ||
| Return | boolean | true if module search is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsModuleNotification | ||
| Description |
Tests if module notification is available. | ||
| Return | boolean | true if module notification is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsModuleCourseCatalog | ||
| Description |
Tests if a module to course catalog lookup session is available. | ||
| Return | boolean | true if module course catalog lookup session is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsModuleCourseCatalogAssignment | ||
| Description |
Tests if a module to course catalog assignment session is available. | ||
| Return | boolean | true if module course catalog assignment is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsModuleSmartCourseCatalog | ||
| Description |
Tests if a module smart course catalog session is available. | ||
| Return | boolean | true if module smart course catalog is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDocetLookup | ||
| Description |
Tests for the availability of a docet lookup service. | ||
| Return | boolean | true if docet lookup is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDocetQuery | ||
| Description |
Tests if querying docetsis available. | ||
| Return | boolean | true if docet query is available, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDocetSearch | ||
| Description |
Tests if searching for docets is available. | ||
| Return | boolean | true if docet search is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDocetAdmin | ||
| Description |
Tests for the availability of a docet administrative service for creating and deleting docets. | ||
| Return | boolean | true if docet administration is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDocetNotification | ||
| Description |
Tests for the availability of a docet notification service. | ||
| Return | boolean | true if docet notification is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented in all providers. | |
| Method | supportsDocetCourseCatalog | ||
| Description |
Tests if a docet to course catalog lookup session is available. | ||
| Return | boolean | true if docet course catalog lookup session is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDocetCourseCatalogAssignment | ||
| Description |
Tests if a docet to course catalog assignment session is available. | ||
| Return | boolean | true if docet course catalog assignment is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDocetSmartCourseCatalog | ||
| Description |
Tests if a docet smart course catalog session is available. | ||
| Return | boolean | true if docet smart course catalog is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCourseSyllabusBatch | ||
| Description |
Tests if a course syllabus batch service is available. | ||
| Return | boolean | true if a course syllabus batch service is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSyllabusRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported syllabus record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSyllabusRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | syllabusRecordType | a Type indicating a Syllabus record type |
| Return | boolean | true if the given Type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | syllabusRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSyllabusSearchRecordTypes | ||
| Description |
Gets the supported syllabus search record types. | ||
| Return | osid.type.TypeList | a list containing the supported syllabus search record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsSyllabusSearchRecordType | ||
| Description |
Tests if the given syllabus search record type is supported. | ||
| Parameters | osid.type.Type | syllabusSearchRecordType | a Type indicating a syllabus record type |
| Return | boolean | true if the given Type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | syllabusSearchRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getModuleRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported module record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsModuleRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | moduleRecordType | a Type indicating a Module record type |
| Return | boolean | true if the given Type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | moduleRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getModuleSearchRecordTypes | ||
| Description |
Gets the supported module search record types. | ||
| Return | osid.type.TypeList | a list containing the supported module search record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsModuleSearchRecordType | ||
| Description |
Tests if the given module search record type is supported. | ||
| Parameters | osid.type.Type | moduleSearchRecordType | a Type indicating a module record type |
| Return | boolean | true if the given Type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | moduleSearchRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDocetRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported docet record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDocetRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | docetRecordType | a Type indicating a Docet record type |
| Return | boolean | true if the given Type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | docetRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDocetSearchRecordTypes | ||
| Description |
Gets the supported docet search record types. | ||
| Return | osid.type.TypeList | a list containing the supported docet search record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsDocetSearchRecordType | ||
| Description |
Tests if the given docet search record type is supported. | ||
| Parameters | osid.type.Type | docetSearchRecordType | a Type indicating a docet record type |
| Return | boolean | true if the given Type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | docetSearchRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |