Interface | osid.billing.batch.ItemBatchAdminSession | ||
---|---|---|---|
Implements | osid.billing.ItemAdminSession | ||
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 | getItemFormsForCreate | ||
Description |
Gets the item forms for creating a bunch of new items. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | itemRecordTypes | array of item record types to be included in each create operation or an empty list if none | |
Return | osid.billing.batch.ItemBatchFormList | the item forms | |
Errors | NULL_ARGUMENT | itemRecordTypes 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 | createItems | ||
Description |
Creates a new set of | ||
Parameters | osid.billing.batch.ItemBatchFormList | itemForms | the item forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | itemForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemFormsForUpdate | ||
Description |
Gets the item forms for updating an existing set of items. A new item form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | itemIds | the Ids of the Item |
Return | osid.billing.batch.ItemBatchFormList | the item form | |
Errors | NOT_FOUND | an itemId is not found | |
NULL_ARGUMENT | itemIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateItems | ||
Description |
Updates existing items. This method returns an error if
the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.billing.batch.ItemBatchFormList | itemForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | itemForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllItems | ||
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 | deleteItems | ||
Description |
Deletes items for the given | ||
Parameters | osid.id.IdList | itemIds | the Ids of the items to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | itemIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasItems | ||
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. |