Interface | osid.hold.batch.OublietteBatchAdminSession | ||
---|---|---|---|
Implements | osid.hold.OublietteAdminSession | ||
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 The delete operations delete | ||
Method | getOublietteFormsForCreate | ||
Description |
Gets the oubliette forms for creating a bunch of new oubliettes. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | oublietteRecordTypes | array of oubliette record types to be included in each create operation or an empty list if none | |
Return | osid.hold.batch.OublietteBatchFormList | the oubliette forms | |
Errors | NULL_ARGUMENT | oublietteRecordTypes 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 | createOubliettes | ||
Description |
Creates a new set of | ||
Parameters | osid.hold.batch.OublietteBatchFormList | oublietteForms | the oubliette forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | oublietteForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOublietteFormsForUpdate | ||
Description |
Gets the oubliette forms for updating an existing set of oubliettes. A new oubliette form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | oublietteIds | the Ids of the Oubliette |
Return | osid.hold.batch.OublietteBatchFormList | the oubliette form | |
Errors | NOT_FOUND | an oublietteId is not found | |
NULL_ARGUMENT | oublietteIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateOubliettes | ||
Description |
Updates existing oubliettes. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.hold.batch.OublietteBatchFormList | oublietteForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | oublietteForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllOubliettes | ||
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 | deleteOubliettes | ||
Description |
Deletes oubliettes for the given | ||
Parameters | osid.id.IdList | oublietteIds | the Ids of the oubliettes to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | oublietteIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasOubliettes | ||
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. |