Interface | osid.course.chronicle.CourseEntryCourseCatalogAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignCourseEntries | ||
Description |
Tests if this user can alter course entry/course
catalog mappings. A return of true does not guarantee
successful authorization. A return of false indicates that
it is known mapping methods in this session will result in
a | ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignCourseEntryToCourseCatalog | ||
Description |
Tests if this user can alter course entry/course
catalog mappings. A return of true does not guarantee
successful authorization. A return of false indicates that
it is known mapping methods in this session will result in
a | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | courseCatalogId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableCourseCatalogIds | ||
Description |
Gets a list of course catalogs including and under the given course catalog node in which any course entry can be assigned. | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
Return | osid.id.IdList | list of assignable course catalog Ids | |
Errors | NULL_ARGUMENT | courseCatalogId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableCourseCatalogIdsForCourseEntry | ||
Description |
Gets a list of course catalogs including and under the given course catalog node in which a specific course entry can be assigned. | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
osid.id.Id | courseEntryId | the Id of the CourseEntry | |
Return | osid.id.IdList | list of assignable course catalog Ids | |
Errors | NULL_ARGUMENT | courseCatalogId or courseEntryId is
null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignCourseEntryToCourseCatalog | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | courseEntryId | the Id of the CourseEntry |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Errors | ALREADY_EXISTS | courseEntryId is already assigned to courseCatalogId
| |
NOT_FOUND | courseEntryId or courseCatalogId not found | ||
NULL_ARGUMENT | courseEntryId or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignCourseEntryFromCourseCatalog | ||
Description |
Removes a | ||
Parameters | osid.id.Id | courseEntryId | the Id of the CourseEntry |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Errors | NOT_FOUND | courseEntryId or courseCatalogId not found or
courseEntryId not assigned to courseCatalogId | |
NULL_ARGUMENT | courseEntryId or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignCourseEntryToCourseCatalog | ||
Description |
Moves a | ||
Parameters | osid.id.Id | courseEntryId | the Id of the CourseEntry |
osid.id.Id | fromCourseCatalogId | the Id of the current CourseCatalog | |
osid.id.Id | toCourseCatalogId | the Id of the destination CourseCatalog | |
Errors | NOT_FOUND | courseEntryId, fromCourseCatalogId, or
toCourseCatalogId not found or courseEntryId not mapped
to fromCourseCatalogId | |
NULL_ARGUMENT | courseEntryId, fromCourseCatalogId, or
toCourseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |