Interface | osid.ordering.batch.OrderingBatchManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.ordering.batch.OrderingBatchProfile | |||
Description |
The ordering batch manager provides access to ordering batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getOrderBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.ordering.batch.OrderBatchAdminSession | a OrderBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOrderBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsOrderBatchAdmin()
is true. | |
Method | getOrderBatchAdminSessionForStore | ||
Description |
Gets the | ||
Parameters | osid.id.Id | storeId | the Id of the Store |
Return | osid.ordering.batch.OrderBatchAdminSession | a OrderBatchAdminSession | |
Errors | NOT_FOUND | no Store found by the given Id | |
NULL_ARGUMENT | storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOrderBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsOrderBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getItemBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.ordering.batch.ItemBatchAdminSession | an ItemBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsItemBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsItemBatchAdmin()
is true. | |
Method | getItemBatchAdminSessionForStore | ||
Description |
Gets the | ||
Parameters | osid.id.Id | storeId | the Id of the Store |
Return | osid.ordering.batch.ItemBatchAdminSession | an ItemBatchAdminSession | |
Errors | NOT_FOUND | no Store found by the given Id | |
NULL_ARGUMENT | storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsItemBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsItemBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getProductBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.ordering.batch.ProductBatchAdminSession | a ProductBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsProductBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsProductBatchAdmin()
is true. | |
Method | getProductBatchAdminSessionForStore | ||
Description |
Gets the | ||
Parameters | osid.id.Id | storeId | the Id of the Store |
Return | osid.ordering.batch.ProductBatchAdminSession | a ProductBatchAdminSession | |
Errors | NOT_FOUND | no Store found by the given Id | |
NULL_ARGUMENT | storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsProductBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsProductBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getPriceScheduleBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.ordering.batch.PriceScheduleBatchAdminSession | a PriceScheduleBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsPriceScheduleBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsPriceScheduleBatchAdmin()
is true. | |
Method | getPriceScheduleBatchAdminSessionForStore | ||
Description |
Gets the | ||
Parameters | osid.id.Id | storeId | the Id of the Store |
Return | osid.ordering.batch.PriceScheduleBatchAdminSession | a PriceScheduleBatchAdminSession | |
Errors | NOT_FOUND | no Store found by the given Id | |
NULL_ARGUMENT | storeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsPriceScheduleBatchAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsPriceScheduleBatchAdmin()
and supportsVisibleFederation() are true | |
Method | getStoreBatchAdminSession | ||
Description |
Gets the | ||
Return | osid.ordering.batch.StoreBatchAdminSession | a StoreBatchAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsStoreBatchAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsStoreBatchAdmin()
is true. |