Interface | osid.course.chronicle.AwardEntryCourseCatalogSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupCourseCatalogMappings | ||
Description |
Tests if this user can perform lookups of award
entry/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 | getAwardEntryIdsByCourseCatalog | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | courseCatalogId | Id of the CourseCatalog |
Return | osid.id.IdList | list of related award entry 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 | getAwardEntriesByCourseCatalog | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | courseCatalogId | Id of the CourseCatalog |
Return | osid.course.chronicle.AwardEntryList | list of related award entries | |
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 | getAwardEntryIdsByCourseCatalogs | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | courseCatalogIds | list of course catalog Ids |
Return | osid.id.IdList | list of award entry 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 | getAwardEntriesByCourseCatalogs | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | courseCatalogIds | list of course catalog Ids |
Return | osid.course.chronicle.AwardEntryList | list of awarde ntries | |
Errors | NULL_ARGUMENT | courseCatalogIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogIdsByAwardEntry | ||
Description |
Gets the | ||
Parameters | osid.id.Id | awardEntryId | Id of a pAwardEntry |
Return | osid.id.IdList | list of course catalog Ids | |
Errors | NOT_FOUND | awardEntryId is not found | |
NULL_ARGUMENT | awardEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogsByAwardEntry | ||
Description |
Gets the | ||
Parameters | osid.id.Id | awardEntryId | Id of an AwardEntry |
Return | osid.course.CourseCatalogList | list of course catalogs | |
Errors | NOT_FOUND | awardEntryId is not found | |
NULL_ARGUMENT | awardEntryId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |