Interface | osid.course.program.EnrollmentAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateEnrollments | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Enrollment creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateEnrollmentWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | enrollmentRecordTypes | array of enrollment record types |
Return | boolean | true if Enrollment creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | enrollmentRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getEnrollmentFormForCreate | ||
Description |
Gets the course form for creating new enrollments. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | programOfferingId | the Id for a ProgramOffering |
osid.id.Id | resourceId | the Id for a Resource | |
osid.type.Type[] | enrollmentRecordTypes | array of enrollment record types | |
Return | osid.course.program.EnrollmentForm | the enrollment form | |
Errors | NOT_FOUND | programOfferingId, or resourceId is not found | |
NULL_ARGUMENT | programOfferingId, resourceId, or
enrollmentRecordTypes is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested recod types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createEnrollment | ||
Description |
Creates a new | ||
Parameters | osid.course.program.EnrollmentForm | enrollmentForm | the form for this Enrollment |
Return | osid.course.program.Enrollment | the new Enrollment | |
Errors | ILLEGAL_STATE | enrollmentForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | enrollmentForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | enrollmentForm did not originate from
getEnrollmentFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateEnrollments | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Enrollment modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEnrollmentFormForUpdate | ||
Description |
Gets the enrollment form for updating an existing enrollment. A new enrollment form should be requested for each update transaction. | ||
Parameters | osid.id.Id | enrollmentId | the Id of the Enrollment |
Return | osid.course.program.EnrollmentForm | the enrollment form | |
Errors | NOT_FOUND | enrollmentId is not found | |
NULL_ARGUMENT | enrollmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateEnrollment | ||
Description |
Updates an existing enrollment. | ||
Parameters | osid.course.program.EnrollmentForm | enrollmentForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | enrollmentForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | enrollmentForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | enrollmentForm did not originate from
getEnrollmentFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteEnrollments | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Enrollment deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteEnrollment | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | enrollmentId | the Id of the Enrollment to remove |
Errors | NOT_FOUND | enrollmentId not found | |
NULL_ARGUMENT | enrollmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageEnrollmentAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Enrollment aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasEnrollment | ||
Description |
Adds an | ||
Parameters | osid.id.Id | enrollmentId | the Id of an Enrollment |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | enrollmentId not found | ||
NULL_ARGUMENT | enrollmentId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |