Interface InventoryBatchManager

All Superinterfaces:

AutoCloseable, Closeable, InventoryBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface InventoryBatchManager
extends OsidManager, InventoryBatchProfile

The inventory batch manager provides access to inventory batch sessions and provides interoperability tests for various aspects of this service. 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

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

Methods inherited from interface Closeable

close

Methods inherited from interface InventoryBatchProfile

supportsInventoryBatchAdmin, supportsItemBatchAdmin, supportsModelBatchAdmin, supportsStockBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsInventoryBatchAdmin()	Tests if bulk administration of inventories is available.
boolean	supportsItemBatchAdmin()	Tests if bulk administration of items is available.
boolean	supportsModelBatchAdmin()	Tests if bulk administration of models is available.
boolean	supportsStockBatchAdmin()	Tests if bulk administration of stocks is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids.
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsItemBatchAdmin()} is {@code true}.

getItemBatchAdminSessionForInventory

ItemBatchAdminSession getItemBatchAdminSessionForInventory(Id inventoryId)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

inventoryId - the Id of the Inventory

Returns:

an ItemBatchAdminSession

Throws:

NotFoundException - no Inventory found by the given Id

NullArgumentException - inventoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getStockBatchAdminSession

StockBatchAdminSession getStockBatchAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk stock administration service.

Returns:

a StockBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStockBatchAdmin() is false

Compliance:

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

getStockBatchAdminSessionForInventory

StockBatchAdminSession getStockBatchAdminSessionForInventory(Id inventoryId)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

inventoryId - the Id of the Inventory

Returns:

a StockBatchAdminSession

Throws:

NotFoundException - no Inventory found by the given Id

NullArgumentException - inventoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getModelBatchAdminSession

ModelBatchAdminSession getModelBatchAdminSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the bulk model administration service.

Returns:

an ModelBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsModelBatchAdmin() is false

Compliance:

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

getModelBatchAdminSessionForInventory

ModelBatchAdminSession getModelBatchAdminSessionForInventory(Id inventoryId)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

inventoryId - the Id of the Inventory

Returns:

an ModelBatchAdminSession

Throws:

NotFoundException - no Inventory found by the given Id

NullArgumentException - inventoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelBatchAdmin() or supportsVisibleFederation() is false

Compliance:

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

getInventoryBatchAdminSession

InventoryBatchAdminSession getInventoryBatchAdminSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the bulk inventory administration service.

Returns:

an InventoryBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryBatchAdmin() is false

Compliance:

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