OSID Logo
OSID Specifications
ordering batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.batch.OrderingBatchManager
Implementsosid.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:

  • OrderBatchAdminSession: a session to create, modify and delete orders in bulk
  • ItemBatchAdminSession: a session to create, modify and delete 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
  • StoreBatchAdminSession: a session to create, modify and delete stores in bulk
MethodgetOrderBatchAdminSession
Description

Gets the OsidSession associated with the bulk order administration service.

Returnosid.ordering.batch.OrderBatchAdminSessiona OrderBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrderBatchAdmin() is false
ComplianceoptionalThis 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.IdstoreIdthe Id of the Store
Returnosid.ordering.batch.OrderBatchAdminSessiona OrderBatchAdminSession
ErrorsNOT_FOUNDno Store found by the given Id
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOrderBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsOrderBatchAdmin() and supportsVisibleFederation() are true
MethodgetItemBatchAdminSession
Description

Gets the OsidSession associated with the bulk item administration service.

Returnosid.ordering.batch.ItemBatchAdminSessionan ItemBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsItemBatchAdmin() is true.
MethodgetItemBatchAdminSessionForStore
Description

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

Parametersosid.id.IdstoreIdthe Id of the Store
Returnosid.ordering.batch.ItemBatchAdminSessionan ItemBatchAdminSession
ErrorsNOT_FOUNDno Store found by the given Id
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemBatchAdmin() and supportsVisibleFederation() are true
MethodgetProductBatchAdminSession
Description

Gets the OsidSession associated with the bulk product administration service.

Returnosid.ordering.batch.ProductBatchAdminSessiona ProductBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProductBatchAdmin() is false
ComplianceoptionalThis 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.IdstoreIdthe Id of the Store
Returnosid.ordering.batch.ProductBatchAdminSessiona ProductBatchAdminSession
ErrorsNOT_FOUNDno Store found by the given Id
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsProductBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis 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.PriceScheduleBatchAdminSessiona PriceScheduleBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPriceScheduleBatchAdmin() is false
ComplianceoptionalThis 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.IdstoreIdthe Id of the Store
Returnosid.ordering.batch.PriceScheduleBatchAdminSessiona PriceScheduleBatchAdminSession
ErrorsNOT_FOUNDno Store found by the given Id
NULL_ARGUMENT storeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPriceScheduleBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPriceScheduleBatchAdmin() and supportsVisibleFederation() are true
MethodgetStoreBatchAdminSession
Description

Gets the OsidSession associated with the bulk store administration service.

Returnosid.ordering.batch.StoreBatchAdminSessiona StoreBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStoreBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsStoreBatchAdmin() is true.