org.osid.inventory.batch

Interface InventoryBatchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, InventoryBatchProfile, OsidProfile, OsidProxyManager, Sourceable

public interface InventoryBatchProxyManager
extends OsidProxyManager, InventoryBatchProfile

The inventory batch proxy manager provides access to inventory 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:

• ItemBatchAdminSession: a session to create, modify and delete items in bulk
• StockBatchSession: a session to create, modify and delete stocks in bulk
• ModelBatchAdminSession: a session to create, modify and delete models in bulk
• InventoryBatchAdminSession: a session to create, modify and delete inventories in bulk

Method Summary

Methods

Modifier and Type	Method and Description
InventoryBatchAdminSession	getInventoryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk inventory administration service.
ItemBatchAdminSession	getItemBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk item administration service.
ItemBatchAdminSession	getItemBatchAdminSessionForInventory(Id inventoryId, Proxy proxy) Gets the OsidSession associated with the bulk item administration service for the given inventory.
ModelBatchAdminSession	getModelBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk model administration service.
ModelBatchAdminSession	getModelBatchAdminSessionForInventory(Id inventoryId, Proxy proxy) Gets the OsidSession associated with the bulk model administration service for the given inventory.
StockBatchAdminSession	getStockBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk stock administration service.
StockBatchAdminSession	getStockBatchAdminSessionForInventory(Id inventoryId, Proxy proxy) Gets the OsidSession associated with the bulk stock administration service for the given inventory.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.inventory.batch.InventoryBatchProfile

supportsInventoryBatchAdmin, supportsItemBatchAdmin, supportsModelBatchAdmin, supportsStockBatchAdmin, 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

getItemBatchAdminSession

ItemBatchAdminSession getItemBatchAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk item administration service.

Parameters:

proxy - a proxy

Returns:

an ItemBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() is false

Compliance:

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

getItemBatchAdminSessionForInventory

ItemBatchAdminSession getItemBatchAdminSessionForInventory(Id inventoryId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

inventoryId - the Id of the Inventory

proxy - a proxy

Returns:

an ItemBatchAdminSession

Throws:

NotFoundException - no Inventory found by the given Id

NullArgumentException - inventoryId or proxy 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

getStockBatchAdminSession

StockBatchAdminSession getStockBatchAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk stock administration service.

Parameters:

proxy - a proxy

Returns:

a StockBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockBatchAdmin() is false

Compliance:

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

getStockBatchAdminSessionForInventory

StockBatchAdminSession getStockBatchAdminSessionForInventory(Id inventoryId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the bulk stock administration service for the given inventory.

Parameters:

inventoryId - the Id of the Inventory

proxy - a proxy

Returns:

a StockBatchAdminSession

Throws:

NotFoundException - no Inventory found by the given Id

NullArgumentException - inventoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getModelBatchAdminSession

ModelBatchAdminSession getModelBatchAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk model administration service.

Parameters:

proxy - a proxy

Returns:

an ModelBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelBatchAdmin() is false

Compliance:

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

getModelBatchAdminSessionForInventory

ModelBatchAdminSession getModelBatchAdminSessionForInventory(Id inventoryId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the bulk model administration service for the given inventory.

Parameters:

inventoryId - the Id of the Inventory

proxy - a proxy

Returns:

an ModelBatchAdminSession

Throws:

NotFoundException - no Inventory found by the given Id

NullArgumentException - inventoryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getInventoryBatchAdminSession

InventoryBatchAdminSession getInventoryBatchAdminSession(Proxy proxy)
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk inventory administration service.

Parameters:

proxy - a proxy

Returns:

an InventoryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryBatchAdmin() is false

Compliance:

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