| Interface | osid.course.program.CredentialCourseCatalogAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignCourses | ||
| Description |
Tests if this user can alter credential/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 | canAssignCredentialToCourseCatalog | ||
| Description |
Tests if this user can alter course/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 credential 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 | getAssignableCourseCatalogIdsForCourse | ||
| Description |
Gets a list of course catalogs including and under the given course catalog node in which a specific credential can be assigned. | ||
| Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
osid.id.Id | credentialId | the Id of the Credential | |
| Return | osid.id.IdList | list of assignable course catalog Ids | |
| Errors | NULL_ARGUMENT | courseCatalogId or credentialId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignCredentialsToCourseCatalog | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | credentialId | the Id of the Credential |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
| Errors | ALREADY_EXISTS | credentialId isalready assigned to courseCatalogId
| |
| NOT_FOUND | credentialId or courseCatalogId not found | ||
| NULL_ARGUMENT | credentialId or courseCatalogId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignCredentialFromCourseCatalog | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | credentialId | the Id of the Credential |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
| Errors | NOT_FOUND | credentialId or courseCatalogId not found or
credentialId not assigned to courseCatalogId | |
| NULL_ARGUMENT | credentialId or courseCatalogId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignCredentialToCourseCatalog | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | credentialId | the Id of the Credential |
osid.id.Id | fromCourseCatalogId | the Id of the current CourseCatalog | |
osid.id.Id | toCourseCatalogId | the Id of the destination CourseCatalog | |
| Errors | NOT_FOUND | credentialId, fromCourseCatalogId, or
toCourseCatalogId not found or crededntialId, not
mapped to fromCourseCatalogId | |
| NULL_ARGUMENT | credentialId, fromCourseCatalogId, or
toCourseCatalogId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |