Interface | osid.repository.batch.CompositionBatchAdminSession | ||
---|---|---|---|
Implements | osid.repository.CompositionAdminSession | ||
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 | getCompositionFormsForCreate | ||
Description |
Gets the composition forms for creating a bunch of new compositions. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | compositionRecordTypes | array of composition record types to be included in each create operation or an empty list if none | |
Return | osid.repository.batch.CompositionBatchFormList | the composition forms | |
Errors | NULL_ARGUMENT | compositionRecordTypes 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 | createCompositions | ||
Description |
Creates a new set of | ||
Parameters | osid.repository.batch.CompositionBatchFormList | compositionForms | the composition forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | compositionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCompositionFormsForUpdate | ||
Description |
Gets the composition forms for updating an existing set of compositions. A new composition form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | compositionIds | the Ids of the Composition |
Return | osid.repository.batch.CompositionBatchFormList | the composition form | |
Errors | NOT_FOUND | a compositionId is not found | |
NULL_ARGUMENT | compositionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateCompositions | ||
Description |
Updates existing compositions. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.repository.batch.CompositionBatchFormList | compositionForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | compositionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllCompositions | ||
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 | deleteCompositions | ||
Description |
Deletes compositions for the given | ||
Parameters | osid.id.IdList | compositionIds | the Ids of the compositions to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | compositionIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveCompositionsByDate | ||
Description |
Deletes compositions expired before 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 | aliasCompositions | ||
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. |