Interface | osid.ordering.batch.ProductBatchAdminSession | ||
---|---|---|---|
Implements | osid.ordering.ProductAdminSession | ||
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 | getProductFormsForCreate | ||
Description |
Gets the product forms for creating a bunch of new products | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | productRecordTypes | array of product record types to be included in each create operation or an empty list if none | |
Return | osid.ordering.batch.ProductBatchFormList | the product forms | |
Errors | NULL_ARGUMENT | productRecordTypes 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 | createProducts | ||
Description |
Creates a new set of | ||
Parameters | osid.ordering.batch.ProductBatchFormList | productForms | the product forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | productForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProductFormsForUpdate | ||
Description |
Gets the product forms for updating an existing set of products. A new product form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | productIds | the Ids of the Product |
Return | osid.ordering.batch.ProductBatchFormList | the product form | |
Errors | NOT_FOUND | a productId is not found | |
NULL_ARGUMENT | productIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProducts | ||
Description |
Updates existing products. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.ordering.batch.ProductBatchFormList | productForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | productForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllProducts | ||
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 | deleteProducts | ||
Description |
Deletes products for the given | ||
Parameters | osid.id.IdList | productIds | the Ids of the products to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | productIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasProducts | ||
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. |