org.osid.ordering.batch

Interface OrderingBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OrderingBatchProfile, OsidManager, OsidProfile, Sourceable

public interface OrderingBatchManager
extends OsidManager, OrderingBatchProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
ItemBatchAdminSession	getItemBatchAdminSession() Gets the OsidSession associated with the bulk item administration service.
ItemBatchAdminSession	getItemBatchAdminSessionForStore(Id storeId) Gets the OsidSession associated with the bulk item administration service for the given store.
OrderBatchAdminSession	getOrderBatchAdminSession() Gets the OsidSession associated with the bulk order administration service.
OrderBatchAdminSession	getOrderBatchAdminSessionForStore(Id storeId) Gets the OsidSession associated with the bulk order administration service for the given store.
PriceScheduleBatchAdminSession	getPriceScheduleBatchAdminSession() Gets the OsidSession associated with the bulk price schedule administration service.
PriceScheduleBatchAdminSession	getPriceScheduleBatchAdminSessionForStore(Id storeId) Gets the OsidSession associated with the bulk price schedule administration service for the given store.
ProductBatchAdminSession	getProductBatchAdminSession() Gets the OsidSession associated with the bulk product administration service.
ProductBatchAdminSession	getProductBatchAdminSessionForStore(Id storeId) Gets the OsidSession associated with the bulk product administration service for the given store.
StoreBatchAdminSession	getStoreBatchAdminSession() Gets the OsidSession associated with the bulk store administration service.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.ordering.batch.OrderingBatchProfile

supportsItemBatchAdmin, supportsOrderBatchAdmin, supportsPriceScheduleBatchAdmin, supportsProductBatchAdmin, supportsStoreBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getOrderBatchAdminSession

OrderBatchAdminSession getOrderBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk order administration service.

Returns:

a OrderBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsOrderBatchAdmin() is true.

getOrderBatchAdminSessionForStore

OrderBatchAdminSession getOrderBatchAdminSessionForStore(Id storeId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

storeId - the Id of the Store

Returns:

a OrderBatchAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOrderBatchAdmin() and supportsVisibleFederation() are true

getItemBatchAdminSession

ItemBatchAdminSession getItemBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk item administration service.

Returns:

an ItemBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsItemBatchAdmin() is true.

getItemBatchAdminSessionForStore

ItemBatchAdminSession getItemBatchAdminSessionForStore(Id storeId)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

storeId - the Id of the Store

Returns:

an ItemBatchAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsItemBatchAdmin() and supportsVisibleFederation() are true

getProductBatchAdminSession

ProductBatchAdminSession getProductBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk product administration service.

Returns:

a ProductBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsProductBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsProductBatchAdmin() is true.

getProductBatchAdminSessionForStore

ProductBatchAdminSession getProductBatchAdminSessionForStore(Id storeId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

storeId - the Id of the Store

Returns:

a ProductBatchAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsProductBatchAdmin() and supportsVisibleFederation() are true

getPriceScheduleBatchAdminSession

PriceScheduleBatchAdminSession getPriceScheduleBatchAdminSession()
                                                                 throws OperationFailedException

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

Returns:

a PriceScheduleBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsPriceScheduleBatchAdmin() is true.

getPriceScheduleBatchAdminSessionForStore

PriceScheduleBatchAdminSession getPriceScheduleBatchAdminSessionForStore(Id storeId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

storeId - the Id of the Store

Returns:

a PriceScheduleBatchAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsPriceScheduleBatchAdmin() and supportsVisibleFederation() are true

getStoreBatchAdminSession

StoreBatchAdminSession getStoreBatchAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk store administration service.

Returns:

a StoreBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStoreBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsStoreBatchAdmin() is true.