| Interface | osid.course.batch.TermBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.course.TermAdminSession | ||
| 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 | getTermFormsForCreate | ||
| Description |
Gets the term forms for creating a bunch of new terms. | ||
| Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | termRecordTypes | array of term record types to be included in each create operation or an empty list if none | |
| Return | osid.course.batch.TermBatchFormList | the term forms | |
| Errors | NULL_ARGUMENT | termRecordTypes 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 | createTerms | ||
| Description |
Creates a new set of | ||
| Parameters | osid.course.batch.TermBatchFormList | termForms | the term forms |
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT | termForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getTermFormsForUpdate | ||
| Description |
Gets the term forms for updating an existing set of terms. A new term form should be requested for each update transaction. | ||
| Parameters | osid.id.IdList | termIds | the Ids of the Term |
| Return | osid.course.batch.TermBatchFormList | the term form | |
| Errors | NOT_FOUND | a termId is not found | |
| NULL_ARGUMENT | termIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateTerms | ||
| Description |
Updates existing terms. 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.batch.TermBatchFormList | termForms | the form containing the elements to be updated |
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT | termForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllTerms | ||
| 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 | deleteTerms | ||
| Description |
Deletes terms for the given | ||
| Parameters | osid.id.IdList | termIds | the Ids of the terms to delete |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | termIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteChildTerms | ||
| Description |
Deletes terms under the given term. | ||
| Parameters | osid.id.Id | termId | an Id of a term |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | termId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteTermsByDate | ||
| Description |
Deletes terms containing 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 | aliasTerms | ||
| 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. | |