Interface | osid.course.chronicle.batch.CourseEntryBatchAdminSession | ||
---|---|---|---|
Implements | osid.course.chronicle.CourseEntryAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getCourseEntryFormsForCreate | ||
Description |
Gets the course entry forms for creating a bunch of new course entries. A form is returned for each course and resource pair. | ||
Parameters | osid.course.chronicle.batch.CourseEntryPeerList | peers | the relationship peers |
osid.type.Type[] | courseEntryRecordTypes | array of course entry record types to be included in each create operation or an empty list if none | |
Return | osid.course.chronicle.batch.CourseEntryBatchFormList | the course entry forms | |
Errors | NOT_FOUND | a courseId or resourceId is not found | |
NULL_ARGUMENT | peers or courseEntryRecordTypes 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 | createCourseEntries | ||
Description |
Creates a new set of | ||
Parameters | osid.course.chronicle.batch.CourseEntryBatchFormList | courseEntryForms | the course entry forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | courseEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCourseEntryFormsForUpdate | ||
Description |
Gets the course entry forms for updating an existing set of course entries. A new course entry form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | courseEntryIds | the Ids of the CourseEntry |
Return | osid.course.chronicle.batch.CourseEntryBatchFormList | the course entry form | |
Errors | NOT_FOUND | a courseEntryId is not found | |
NULL_ARGUMENT | courseEntryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCourseEntries | ||
Description |
Updates existing course entries. 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.chronicle.batch.CourseEntryBatchFormList | courseEntryForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | courseEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllCourseEntries | ||
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 | deleteCourseEntries | ||
Description |
Deletes course entries for the given | ||
Parameters | osid.id.IdList | courseEntryIds | the Ids of the course entries to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | courseEntryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteCourseEntriesForCourse | ||
Description |
Deletes course entries for the given course. | ||
Parameters | osid.id.Id | courseId | the Id of a course |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | courseId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteCourseEntriesForStudent | ||
Description |
Deletes course entries for the given student. | ||
Parameters | osid.id.Id | resourceId | the 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 | deleteIneffectiveCourseEntriesByDate | ||
Description |
Deletes course entries 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 | aliasCourseEntries | ||
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. |