| Interface | osid.lexicon.batch.IdiomBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.lexicon.IdiomAdminSession | ||
| Used By | osid.lexicon.batch.LexiconBatchManager | ||
osid.lexicon.batch.LexiconBatchProxyManager | |||
| Description |
This session creates, updates, and deletes
Create and update operations differ in their usage. To
create an The Idiom Forms returned from
getIdiomFormsForCreate() may be linked to the
originating request through the peer Ids of the
IdiomForm . In the case where there may be
duplicates, a ny IdiomForm of the same peer Ids
may be used for a create operation.
Once a batch of For updates, Once a batch of The delete operations delete Idio | ||
| Method | getIdiomFormsForCreate | ||
| Description |
Gets the idioms forms for creating a bunch of new
idioms. A new form is returned for each supplied text
| ||
| Parameters | osid.id.IdList | textIds | a list of text Ids |
osid.type.Type[] | IdiomRecordTypes | array of idiom record types to be included in each create operation or an empty list if none | |
| Return | osid.lexicon.batch.IdiomBatchFormList | the idiom forms | |
| Errors | NOT_FOUND | a textId is not found | |
| NULL_ARGUMENT | textIds or IdiomRecordTypes 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 | createIdioms | ||
| Description |
Creates a new set of | ||
| Parameters | osid.lexicon.batch.IdiomBatchFormList | IdiomForms | the idiom forms |
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT | IdiomForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getIdiomFormsForUpdate | ||
| Description |
Gets the idiom forms for updating an existing set of idioms. A new idiom form should be requested for each update transaction. | ||
| Parameters | osid.id.IdList | IdiomIds | the Ids of the Idiom |
| Return | osid.lexicon.batch.IdiomBatchFormList | the idiom form | |
| Errors | NOT_FOUND | an IdiomId is not found | |
| NULL_ARGUMENT | IdiomIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateIdioms | ||
| Description |
Updates existing idioms. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the
| ||
| Parameters | osid.lexicon.batch.IdiomBatchFormList | IdiomForms | the form containing the elements to be updated |
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT | IdiomForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllIdioms | ||
| 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 | deleteIdioms | ||
| Description |
Deletes idioms for the given | ||
| Parameters | osid.id.IdList | IdiomIds | the Ids of the idioms to delete |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | IdiomIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasIdioms | ||
| 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. | |