OSID Logo
OSID Specifications
ordering batch package
Version 3.1.0
Interfaceosid.ordering.batch.OrderingBatchManager
Implementsosid.OsidManager
osid.ordering.batch.OrderingBatchProfile
Used Byosid.ordering.OrderingManager
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:

  • OrderBatchAdminSession: a session to create, modify and delete orders in bulk
  • OrderItemBatchAdminSession: a session to create, modify and delete order items in bulk
  • ProductBatchSession: a session to create, modify and delete products in bulk
  • PriceScheduleBatchAdminSession: a session to create, modify and delete price schedules in bulk
  • PriceBatchAdminSession: a session to create, modify and delete prices in bulk
  • StoreBatchAdminSession: a session to create, modify and delete stores in bulk
OrderingBatchManager may be accessed by multiple processing threads.
MethodgetOrderBatchAdminSession
Description

Gets the OsidSession associated with the bulk order administration service.

Returnosid.ordering.batch.OrderBatchAdminSession a OrderBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrderBatchAdmin() is false
Complianceoptional This method must be implemented if supportsOrderBatchAdmin() is true.
MethodgetOrderBatchAdminSessionForStore
Description

Gets the OsidSession associated with the bulk order administration service for the given store.

Parametersosid.id.IdstoreId the Id of the Store
Returnosid.ordering.batch.OrderBatchAdminSession a OrderBatchAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsOrderBatchAdmin() and supportsVisibleFederation() are true
MethodgetOrderItemBatchAdminSession
Description

Gets the OsidSession associated with the bulk order item administration service.

Returnosid.ordering.batch.OrderItemBatchAdminSession an OrderItemBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrderItemBatchAdmin() is false
Complianceoptional This method must be implemented if supportsOrderItemBatchAdmin() is true.
MethodgetOrderItemBatchAdminSessionForStore
Description

Gets the OsidSession associated with the bulk order item administration service for the given store.

Parametersosid.id.IdstoreId the Id of the Store
Returnosid.ordering.batch.OrderItemBatchAdminSession an OrderItemBatchAdminSession
ErrorsNOT_FOUND no Store found by the given Id
NULL_ARGUMENT storeId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOrderItemBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsOrderItemBatchAdmin() and supportsVisibleFederation() are true
MethodgetProductBatchAdminSession
Description

Gets the OsidSession associated with the bulk product administration service.

Returnosid.ordering.batch.ProductBatchAdminSession a ProductBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsProductBatchAdmin() is false
Complianceoptional This method must be implemented if supportsProductBatchAdmin() is true.
MethodgetProductBatchAdminSessionForStore
Description

Gets the OsidSession associated with the bulk product administration service for the given store.

Parametersosid.id.IdstoreId the Id of the Store
Returnosid.ordering.batch.ProductBatchAdminSession a ProductBatchAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsProductBatchAdmin() and supportsVisibleFederation() are true
MethodgetPriceScheduleBatchAdminSession
Description

Gets the OsidSession associated with the bulk price schedule administration service.

Returnosid.ordering.batch.PriceScheduleBatchAdminSession a PriceScheduleBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPriceScheduleBatchAdmin() is false
Complianceoptional This method must be implemented if supportsPriceScheduleBatchAdmin() is true.
MethodgetPriceScheduleBatchAdminSessionForStore
Description

Gets the OsidSession associated with the bulk price schedule administration service for the given store.

Parametersosid.id.IdstoreId the Id of the Store
Returnosid.ordering.batch.PriceScheduleBatchAdminSession a PriceScheduleBatchAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsPriceScheduleBatchAdmin() and supportsVisibleFederation() are true
MethodgetPriceBatchAdminSession
Description

Gets the OsidSession associated with the bulk price administration service.

Returnosid.ordering.batch.PriceBatchAdminSession a PriceBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPriceBatchAdmin() is false
Complianceoptional This method must be implemented if supportsPriceBatchAdmin() is true.
MethodgetPriceBatchAdminSessionForStore
Description

Gets the OsidSession associated with the bulk price administration service for the given store.

Parametersosid.id.IdstoreId the Id of the Store
Returnosid.ordering.batch.PriceBatchAdminSession a PriceBatchAdminSession
ErrorsNOT_FOUND no Store found by the given Id
NULL_ARGUMENT storeId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsPriceBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsPriceBatchAdmin() and supportsVisibleFederation() are true
MethodgetStoreBatchAdminSession
Description

Gets the OsidSession associated with the bulk store administration service.

Returnosid.ordering.batch.StoreBatchAdminSession a StoreBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsStoreBatchAdmin() is false
Complianceoptional This method must be implemented if supportsStoreBatchAdmin() is true.