Interface | osid.course.chronicle.batch.AwardEntryBatchAdminSession | ||
---|---|---|---|
Implements | osid.course.chronicle.AwardEntryAdminSession | ||
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 | getAwardEntryFormsForCreate | ||
Description |
Gets the award entry forms for creating a bunch of new award entries. A form is returned for each award and student pair. | ||
Parameters | osid.course.chronicle.batch.AwardEntryPeerList | peers | the relationship peers |
osid.type.Type[] | awardEntryRecordTypes | array of award entry record types to be included in each create operation or an empty list if none | |
Return | osid.course.chronicle.batch.AwardEntryBatchFormList | the award entry forms | |
Errors | NOT_FOUND | an awardId or studentId is not found | |
NULL_ARGUMENT | peers or awardEntryRecordTypes 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 | createAwardEntries | ||
Description |
Creates a new set of | ||
Parameters | osid.course.chronicle.batch.AwardEntryBatchFormList | awardEntryForms | the award entry forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | awardEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardEntryFormsForUpdate | ||
Description |
Gets the award entry forms for updating an existing set of award entries. A new award entry form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | awardEntryIds | the Ids of the AwardEntry |
Return | osid.course.chronicle.batch.AwardEntryBatchFormList | the award entry form | |
Errors | NOT_FOUND | an awardEntryId is not found | |
NULL_ARGUMENT | awardEntryIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAwardEntries | ||
Description |
Updates existing award 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.AwardEntryBatchFormList | awardEntryForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | awardEntryForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllAwardEntries | ||
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 | deleteAwardEntries | ||
Description |
Deletes award entries for the given | ||
Parameters | osid.id.IdList | awardEntryIds | the Ids of the award entries to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | awardEntryIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAwardEntriesForAward | ||
Description |
Deletes award entries for the given award. | ||
Parameters | osid.id.IdList | awardId | an Id of an award |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | awardId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAwardEntriesForStudent | ||
Description |
Deletes award entries for the given student. | ||
Parameters | osid.id.IdList | resourceId | an 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 | deleteIneffectiveAwardEntriesByDate | ||
Description |
Deletes award 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 | aliasAwardEntries | ||
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. |