| Interface | osid.dictionary.batch.EntryBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.dictionary.EntryAdminSession | ||
| Used By | osid.dictionary.batch.DictionaryBatchManager | ||
osid.dictionary.batch.DictionaryBatchProxyManager | |||
| 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 EntryDictionaryAssignmentSession should be used.
These delete operations attempt to remove the
Entry itself thus removing it from all known
Dictionary catalogs. Bulk delete operations
return the results in DeleteResponses . | ||
| Method | getEntryFormsForCreate | ||
| Description |
Gets the entry forms for creating a bunch of new entries. A form is returned for each work and resource pair. | ||
| Parameters | osid.dictionary.batch.EntryPeerList | peers | the entry peers |
osid.type.Type[] | entryRecordTypes | array of entry record types to be included in each create operation or an empty list if none | |
| Return | osid.dictionary.batch.EntryBatchFormList | the entry forms | |
| Errors | NOT_FOUND | a workId or resourceId is not found | |
| NULL_ARGUMENT | peers or entryRecordTypes 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 | createEntries | ||
| Description |
Creates a new set of | ||
| Parameters | osid.dictionary.batch.EntryBatchFormList | entryForms | the entry forms |
| Return | osid.transaction.batch.CreateResponseList | the entry responses | |
| Errors | NULL_ARGUMENT | entryForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getEntryFormsForUpdate | ||
| Description |
Gets the entry forms for updating an existing set of entries. A new entry form should be requested for each update transaction. | ||
| Parameters | osid.id.IdList | entryIds | the Ids of the Entries |
| Return | osid.dictionary.batch.EntryBatchFormList | the entry forms | |
| Errors | NOT_FOUND | an entryId is not found | |
| NULL_ARGUMENT | entryIds is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateEntries | ||
| Description |
Updates existing 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.dictionary.batch.EntryBatchFormList | entryForms | the form containing the elements to be updated |
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT | entryForms is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllEntries | ||
| 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 | deleteEntries | ||
| Description |
Deletes entries for the given | ||
| Parameters | osid.id.IdList | entryIds | the Ids of the entries to delete |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | entryIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteEntriesForKey | ||
| Description |
Deletes entries for the given key | ||
| Parameters | osid.type.Type | keyType | the key type |
object | key | the key | |
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT | keyType or key is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasEntries | ||
| 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. | |