Interface | osid.course.plan.PlanCourseCatalogSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupPlanCourseCatalogMappings | ||
Description |
Tests if this user can perform lookups of plan/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 | getPlanIdsByCourseCatalog | ||
Description |
Gets the list of Plan Ids associated with an | ||
Parameters | osid.id.Id | courseCatalogId | Id of an CourseCatalog. |
Return | osid.id.IdList | list of related plan 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 | getPlansByCourseCatalog | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | courseCatalogId | Id of an CourseCatalog |
Return | osid.course.plan.PlanList | list of related plans | |
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 | getPlanIdsByCourseCatalogs | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | courseCatalogIds | list of course catalog Ids |
Return | osid.id.IdList | list of plan 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 | getPlansByCourseCatalogs | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | courseCatalogIds | list of course catalog Ids |
Return | osid.course.plan.PlanList | list of plans | |
Errors | NULL_ARGUMENT | courseCatalogIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogIdsByPlan | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | planId | Id of a Plan |
Return | osid.id.IdList | list of course catalog Ids | |
Errors | NOT_FOUND | planId is not found | |
NULL_ARGUMENT | planId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalogsByPlan | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | planId | Id of a Plan |
Return | osid.course.CourseCatalogList | list of course catalogs | |
Errors | NOT_FOUND | planId is not found | |
NULL_ARGUMENT | planId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |