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 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} .