Interface | osid.course.syllabus.SyllabusLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving syllabi. This lookup session defines several views:
The methods | ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupSyllabi | ||
Description |
Tests if this user can lookup syllabi. A return of true
does not guarantee successful authorization. A return of
false indicates that it is known all methods in this
session will result in a | ||
Return | boolean | false if syllabus lookup methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeSyllabusView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenarySyllabusView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedCourseCatalogView | ||
Description |
Federates the view for methods in this session. A federated view will include syllabi in course catalogs which are children of this course catalog in the course catalog hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCourseCatalogView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSyllabus | ||
Description |
Gets the | ||
Parameters | osid.id.Id | syllabusId | the Id of the Syllabus to retrieve |
Return | osid.course.syllabus.Syllabus | the returned Syllabus | |
Errors | NOT_FOUND | no Syllabus found with the given Id | |
NULL_ARGUMENT | syllabusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSyllabiByIds | ||
Description |
Gets a | ||
Parameters | osid.id.IdList | syllabusIds | the list of Ids to retrieve |
Return | osid.course.syllabus.SyllabusList | the returned Syllabus list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | syllabusIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSyllabiByGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | syllabusGenusType | a syllabus genus type |
Return | osid.course.syllabus.SyllabusList | the returned Syllabus list | |
Errors | NULL_ARGUMENT | syllabusGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSyllabiByParentGenusType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | syllabusGenusType | a syllabus genus type |
Return | osid.course.syllabus.SyllabusList | the returned Syllabus list | |
Errors | NULL_ARGUMENT | syllabusGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSyllabiByRecordType | ||
Description |
Gets a | ||
Parameters | osid.type.Type | syllabusRecordType | a syllabus record type |
Return | osid.course.syllabus.SyllabusList | the returned Syllabus list | |
Errors | NULL_ARGUMENT | syllabusRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSyllabiForCourse | ||
Description |
Gets a | ||
Parameters | osid.id.Id | courseId | a course Id |
Return | osid.course.syllabus.SyllabusList | the returned Syllabus list | |
Errors | NULL_ARGUMENT | courseId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSyllabi | ||
Description |
Gets all syllabi. In plenary mode, the returned list contains all known syllabi or an error results. Otherwise, the returned list may contain only those syllabi that are accessible through this session. | ||
Return | osid.course.syllabus.SyllabusList | a list of syllabi | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |