Interface | osid.recognition.batch.AcademyBatchAdminSession | ||
---|---|---|---|
Implements | osid.recognition.AcademyAdminSession | ||
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 | getAcademyFormsForCreate | ||
Description |
Gets the academy forms for creating a bunch of new academy. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | academyRecordTypes | array of academy record types to be included in each create operation or an empty list if none | |
Return | osid.recognition.batch.AcademyBatchFormList | the academy forms | |
Errors | NULL_ARGUMENT | academyRecordTypes 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 | createAcademies | ||
Description |
Creates a new set of | ||
Parameters | osid.recognition.batch.AcademyBatchFormList | academyForms | the academy forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | academyForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAcademyFormsForUpdate | ||
Description |
Gets the academy forms for updating an existing set of academies. A new academy form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | academyIds | the Ids of the Academies |
Return | osid.recognition.batch.AcademyBatchFormList | the academy form | |
Errors | NOT_FOUND | a academyId is not found | |
NULL_ARGUMENT | academyIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAcademies | ||
Description |
Updates existing academies. 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.AcademyBatchFormList | academyForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | academyForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllAcademies | ||
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 | deleteAcademies | ||
Description |
Deletes academies for the given | ||
Parameters | osid.id.IdList | academyIds | the Ids of the academies to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | academyIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasAcademies | ||
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. |