Interface | osid.recognition.batch.AwardBatchAdminSession | ||
---|---|---|---|
Implements | osid.recognition.AwardAdminSession | ||
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 | getAwardFormsForCreate | ||
Description |
Gets the award forms for creating a bunch of new awards. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | awardRecordTypes | array of award record types to be included in each create operation or an empty list if none | |
Return | osid.recognition.batch.AwardBatchFormList | the award forms | |
Errors | NULL_ARGUMENT | awardRecordTypes 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 | createAwards | ||
Description |
Creates a new set of | ||
Parameters | osid.recognition.batch.AwardBatchFormList | awardForms | the award forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | awardForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAwardFormsForUpdate | ||
Description |
Gets the award forms for updating an existing set of awards. A new award form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | awardIds | the Ids of the Award |
Return | osid.recognition.batch.AwardBatchFormList | the award form | |
Errors | NOT_FOUND | an awardId is not found | |
NULL_ARGUMENT | awardIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAwards | ||
Description |
Updates existing awards. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.recognition.batch.AwardBatchFormList | awardForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | awardForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllAwards | ||
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 | deleteAwards | ||
Description |
Deletes awards for the given | ||
Parameters | osid.id.IdList | awardIds | the Ids of the awards to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | awardIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasAwards | ||
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. |