Interface | osid.course.syllabus.DocetCourseCatalogSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupDocetCourseCatalogMappings | ||
Description |
Tests if this user can perform lookups of docet/course
catalog mappings. A return of true does not guarantee
successful authorization. A return of false indicates that
it is known lookup methods in this session will result in
a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeCourseCatalogView | ||
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 | usePlenaryCourseCatalogView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getDocetIdsByCourseCatalog | ||
Description |
Gets the list of Docet Ids associated with an | ||
Parameters | osid.id.Id | courseCatalogId | Id of an CourseCatalog. |
Return | osid.id.IdList | list of related docet Ids | |
Errors | NOT_FOUND | courseCatalogId is not found | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDocetsByCourseCatalog | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | courseCatalogId | Id of an CourseCatalog |
Return | osid.course.syllabus.DocetList | list of related docets | |
Errors | NOT_FOUND | courseCatalogId is not found | |
NULL_ARGUMENT | courseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDocetIdsByCourseCatalogs | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | courseCatalogIds | list of course catalog Ids |
Return | osid.id.IdList | list of docet Ids | |
Errors | NULL_ARGUMENT | courseCatalogIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDocetsByCourseCatalogs | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | courseCatalogIds | list of course catalog Ids |
Return | osid.course.syllabus.DocetList | list of docets | |
Errors | NULL_ARGUMENT | courseCatalogIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogIdsByDocet | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | docetId | Id of an Docet |
Return | osid.id.IdList | list of course catalog Ids | |
Errors | NOT_FOUND | docetId is not found | |
NULL_ARGUMENT | docetId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogsByDocet | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | docetId | Id of an Docet |
Return | osid.course.CourseCatalogList | list of course catalogs | |
Errors | NOT_FOUND | docetId is not found | |
NULL_ARGUMENT | docetId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |