Interface | osid.course.program.batch.EnrollmentBatchAdminSession | ||
---|---|---|---|
Implements | osid.course.program.EnrollmentAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getEnrollmentFormsForCreate | ||
Description |
Gets the enrollment forms for creating a bunch of new enrollments. A form is returned for each activity and resource pair. | ||
Parameters | osid.course.program.batch.EnrollmentPeerList | peers | the relationship peers |
osid.type.Type[] | enrollmentRecordTypes | array of enrollment record types to be included in each create operation or an empty list if none | |
Return | osid.course.program.batch.EnrollmentBatchFormList | the enrollment forms | |
Errors | NOT_FOUND | a programId or resourceId is not found | |
NULL_ARGUMENT | peers or enrollmentRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createEnrollments | ||
Description |
Creates a new set of | ||
Parameters | osid.course.program.batch.EnrollmentBatchFormList | enrollmentForms | the enrollment forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | enrollmentForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEnrollmentFormsForUpdate | ||
Description |
Gets the enrollment forms for updating an existing set of enrollments. A new enrollment form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | enrollmentIds | the Ids of the Enrollment |
Return | osid.course.program.batch.EnrollmentBatchFormList | the enrollment form | |
Errors | NOT_FOUND | an enrollmentId is not found | |
NULL_ARGUMENT | enrollmentIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateEnrollments | ||
Description |
Updates existing enrollments. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.course.program.batch.EnrollmentBatchFormList | enrollmentForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | enrollmentForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllEnrollments | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteEnrollments | ||
Description |
Deletes enrollments for the given | ||
Parameters | osid.id.IdList | enrollmentIds | the Ids of the enrollments to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | enrollmentIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteEnrollmentsForProgramOffering | ||
Description |
Deletes enrollments for the given program offering. | ||
Parameters | osid.id.Id | programOfferingId | an Id of a program |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | programOfferingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteEnrollmentsForStudent | ||
Description |
Deletes enrollments for the given student resource. | ||
Parameters | osid.id.Id | resourceId | an Id of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveEnrollmentsByDate | ||
Description |
Deletes enrollments expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasEnrollments | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |