Interface OrderingBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OrderingBatchProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface OrderingBatchProxyManager
extends OsidProxyManager, OrderingBatchProfile

The ordering batch proxy manager provides access to ordering batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. 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

OrderingBatchProxyManager may be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
OrderBatchAdminSession	getOrderBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk order administration service.
OrderBatchAdminSession	getOrderBatchAdminSessionForStore(Id storeId, Proxy proxy)	Gets the OsidSession associated with the bulk order administration service for the given store.
OrderItemBatchAdminSession	getOrderItemBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk order item administration service.
OrderItemBatchAdminSession	getOrderItemBatchAdminSessionForStore(Id storeId, Proxy proxy)	Gets the OsidSession associated with the bulk order item administration service for the given store.
PriceBatchAdminSession	getPriceBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk price administration service.
PriceBatchAdminSession	getPriceBatchAdminSessionForStore(Id storeId, Proxy proxy)	Gets the OsidSession associated with the bulk price administration service for the given store.
PriceScheduleBatchAdminSession	getPriceScheduleBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk price schedule administration service.
PriceScheduleBatchAdminSession	getPriceScheduleBatchAdminSessionForStore(Id storeId, Proxy proxy)	Gets the OsidSession associated with the bulk price schedule administration service for the given store.
ProductBatchAdminSession	getProductBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk product administration service.
ProductBatchAdminSession	getProductBatchAdminSessionForStore(Id storeId, Proxy proxy)	Gets the OsidSession associated with the bulk product administration service for the given store.
StoreBatchAdminSession	getStoreBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk store administration service.

Methods inherited from interface Closeable

close

Methods inherited from interface OrderingBatchProfile

supportsOrderBatchAdmin, supportsOrderItemBatchAdmin, supportsPriceBatchAdmin, supportsPriceScheduleBatchAdmin, supportsProductBatchAdmin, supportsStoreBatchAdmin, supportsVisibleFederation

Methods inherited from interface OsidProfile

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

Methods inherited from interface OsidProxyManager

close

Methods inherited from interface OsidProxyManager

changeBranch, getProxy, getProxyCondition, initialize, rollbackService

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details

getOrderBatchAdminSession

OrderBatchAdminSession getOrderBatchAdminSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk order administration service.

Parameters:

proxy - a proxy

Returns:

a OrderBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsOrderBatchAdmin()} is {@code true}.

getOrderBatchAdminSessionForStore

OrderBatchAdminSession getOrderBatchAdminSessionForStore(Id storeId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a OrderBatchAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsOrderBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getOrderItemBatchAdminSession

OrderItemBatchAdminSession getOrderItemBatchAdminSession(Proxy proxy)
                                                  throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

an OrderItemBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderItemBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsOrderItemBatchAdmin()} is {@code true}.

getOrderItemBatchAdminSessionForStore

OrderItemBatchAdminSession getOrderItemBatchAdminSessionForStore(Id storeId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

an OrderItemBatchAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOrderItemBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsOrderItemBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getProductBatchAdminSession

ProductBatchAdminSession getProductBatchAdminSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the bulk product administration service.

Parameters:

proxy - a proxy

Returns:

a ProductBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsProductBatchAdmin()} is {@code true}.

getProductBatchAdminSessionForStore

ProductBatchAdminSession getProductBatchAdminSessionForStore(Id storeId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a ProductBatchAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsProductBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsProductBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getPriceScheduleBatchAdminSession

PriceScheduleBatchAdminSession getPriceScheduleBatchAdminSession(Proxy proxy)
                                                          throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a PriceScheduleBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsPriceScheduleBatchAdmin()} is {@code true}.

getPriceScheduleBatchAdminSessionForStore

PriceScheduleBatchAdminSession getPriceScheduleBatchAdminSessionForStore(Id storeId,
 Proxy proxy)
                                                                  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

proxy - a proxy

Returns:

a PriceScheduleBatchAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceScheduleBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPriceScheduleBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getPriceBatchAdminSession

PriceBatchAdminSession getPriceBatchAdminSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk price administration service.

Parameters:

proxy - a proxy

Returns:

a PriceBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsPriceBatchAdmin()} is {@code true}.

getPriceBatchAdminSessionForStore

PriceBatchAdminSession getPriceBatchAdminSessionForStore(Id storeId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

storeId - the Id of the Store

proxy - a proxy

Returns:

a PriceBatchAdminSession

Throws:

NotFoundException - no Store found by the given Id

NullArgumentException - storeId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPriceBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPriceBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getStoreBatchAdminSession

StoreBatchAdminSession getStoreBatchAdminSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk store administration service.

Parameters:

proxy - a proxy

Returns:

a StoreBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStoreBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsStoreBatchAdmin()} is {@code true}.