| Interface | osid.course.chronicle.batch.ProgramEntryBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.course.chronicle.ProgramEntryAdminSession | ||
| 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 | getProgramEntryFormsForCreate | ||
| Description |
Gets the program entry forms for creating a bunch of
new program entries. A | ||
| Parameters | osid.course.chronicle.batch.ProgramEntryPeerList | peers | a list of program entry peers |
osid.type.Type[] | programEntryRecordTypes | array of program entry record types to be included in each create operation or an empty list if none | |
| Return | osid.course.chronicle.batch.ProgramEntryBatchFormList | the program entry forms | |
| Errors | NOT_FOUND | a programId or studentId is not found | |
| NULL_ARGUMENT | peers or programEntryRecordTypes 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 | createProgramEntries | ||
| Description |
Creates a new set of | ||
| Parameters | osid.course.chronicle.batch.ProgramEntryBatchFormList | programEntryForms | the program entry forms |
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT | programEntryForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getProgramEntryFormsForUpdate | ||
| Description |
Gets the program entry forms for updating an existing set of program entries. A new program entry form should be requested for each update transaction. | ||
| Parameters | osid.id.IdList | programEntryIds | the Ids of the ProgramEntry |
| Return | osid.course.chronicle.batch.ProgramEntryBatchFormList | the program entry form | |
| Errors | NOT_FOUND | a programEntryId is not found | |
| NULL_ARGUMENT | programEntryIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateProgramEntries | ||
| Description |
Updates existing program 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.ProgramEntryBatchFormList | programEntryForms | the form containing the elements to be updated |
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT | programEntryForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllProgramEntries | ||
| 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 | deleteProgramEntries | ||
| Description |
Deletes program entries for the given | ||
| Parameters | osid.id.IdList | programEntryIds | the Ids of the program entries to delete |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | programEntryIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteProgramEntriesForProgram | ||
| Description |
Deletes program entries for the given program. | ||
| Parameters | osid.id.Id | programId | the Id of a program |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | programId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteProgramEntriesForStudent | ||
| Description |
Deletes program entries for the given student | ||
| Parameters | osid.id.Id | resourceId | the Id of a student |
| 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 | deleteIneffectiveProgramEntriesByDate | ||
| Description |
Deletes program 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 | aliasProgramEntries | ||
| 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. | |