Interface | osid.course.program.EnrollmentCourseCatalogAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of an | ||
Method | canAssignEnrollments | ||
Description |
Tests if this user can alter enrollment/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 | canAssignEnrollmentToCourseCatalog | ||
Description |
Tests if this user can alter enrollment/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 enrollment 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 | getAssignableCourseCatalogIdsForEnrollment | ||
Description |
Gets a list of course catalogs including and under the given course catalog node in which a specific enrollment can be assigned. | ||
Parameters | osid.id.Id | courseCatalogId | the Id of the CourseCatalog |
osid.id.Id | enrollmentId | the Id of the Enrollment | |
Return | osid.id.IdList | list of assignable course catalog Ids | |
Errors | NULL_ARGUMENT | courseCatalogId or enrollmentId is
null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignEnrollmentToCatalog | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | enrollmentId | the Id of the Enrollment |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Errors | ALREADY_EXISTS | enrollmentId is already assigned to courseCatalogId
| |
NOT_FOUND | enrollmentId or courseCatalogId not found | ||
NULL_ARGUMENT | enrollmentId or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignEnrollmentFromCourseCatalog | ||
Description |
Removes an | ||
Parameters | osid.id.Id | enrollmentId | the Id of the Enrollment |
osid.id.Id | courseCatalogId | the Id of the CourseCatalog | |
Errors | NOT_FOUND | enrollmentId or courseCatalogId not found or
enrollmentId not assigned to courseCatalogId | |
NULL_ARGUMENT | enrollmentId or courseCatalogId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignEnrollmeentToCourseCatalog | ||
Description |
Moves an | ||
Parameters | osid.id.Id | enrollmentId | the Id of the Enrollment |
osid.id.Id | fromCourseCatalogId | the Id of the current CourseCatalog | |
osid.id.Id | toCourseCatalogId | the Id of the destination CourseCatalog | |
Errors | NOT_FOUND | enrollmentId, fromCourseCatalogId, or
toCourseCatalogId not found or enrollmentId, not mapped
to fromCourseCatalogId | |
NULL_ARGUMENT | enrollmentId, fromCourseCatalogId, or
toCourseCatalogId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |