Interface | osid.ordering.batch.PriceScheduleBatchAdminSession | ||
---|---|---|---|
Implements | osid.ordering.PriceScheduleAdminSession | ||
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 | getPriceScheduleFormsForCreate | ||
Description |
Gets the price schedule forms for creating a bunch of new price schedules. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | priceScheduleRecordTypes | array of price schedule record types to be included in each create operation or an empty list if none | |
Return | osid.ordering.batch.PriceScheduleBatchFormList | the price schedule forms | |
Errors | NULL_ARGUMENT | priceScheduleRecordTypes 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 | createPriceSchedules | ||
Description |
Creates a new set of | ||
Parameters | osid.ordering.batch.PriceScheduleBatchFormList | priceScheduleForms | the price schedule forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | priceScheduleForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPriceScheduleFormsForUpdate | ||
Description |
Gets the price schedule forms for updating an existing set of price schedules. A new price schedule form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | priceScheduleIds | the Ids of the PriceSchedules |
Return | osid.ordering.batch.PriceScheduleBatchFormList | the price schedule form | |
Errors | NOT_FOUND | a priceScheduleId is not found | |
NULL_ARGUMENT | priceScheduleIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePriceSchedules | ||
Description |
Updates existing price schedules. 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.PriceScheduleBatchFormList | priceScheduleForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | priceScheduleForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllPriceSchedules | ||
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 | deletePriceSchedules | ||
Description |
Deletes price schedules for the given | ||
Parameters | osid.id.IdList | priceScheduleIds | the Ids of the price schedules to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | priceScheduleIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasPriceSchedules | ||
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. | |
Method | getPriceFormsForCreate | ||
Description |
Gets the price forms for creating a bunch of new prices. A form is returned for each supplied price schedule. | ||
Parameters | osid.id.IdList | priceScheduleIds | a list of price schedule Ids |
osid.type.Type[] | priceScheduleRecordTypes | array of price schedule record types to be included in each create operation or an empty list if none | |
Return | osid.ordering.batch.PriceBatchFormList | the price schedule forms | |
Errors | NOT_FOUND | a priceScheduleId is not found | |
NULL_ARGUMENT | priceScheduleId or priceScheduleRecordTypes
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 | createPrices | ||
Description |
Creates a new set of | ||
Parameters | osid.ordering.batch.PriceBatchFormList | priceForms | the price forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | priceForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPriceFormsForUpdate | ||
Description |
Gets the price forms for updating an existing set of prices. A new price form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | priceIds | the Ids of the Prices |
Return | osid.ordering.batch.PriceBatchFormList | the price forms | |
Errors | NOT_FOUND | a priceId is not found | |
NULL_ARGUMENT | priceIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePrices | ||
Description |
Updates existing prices. 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.PriceBatchFormList | priceForms | the forms containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | priceForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllPrices | ||
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 | deletePrices | ||
Description |
Deletes prices for the given | ||
Parameters | osid.id.IdList | priceIds | the Ids of the price to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | priceIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deletePricesForPriceSchedule | ||
Description |
Deletes prices for the given price schedule. | ||
Parameters | osid.id.Id | priceScheduleId | the Id ofa price schedule |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | priceScheduleId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasPrices | ||
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. |