Interface InventoryProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
InventoryManager, InventoryProxyManager
public interface InventoryProfile extends OsidProfile

The inventory profile describes the interoperability of inventory services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if visible federation is supported.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemLookup

      boolean supportsItemLookup()
      Tests if looking up items is supported.
      Returns:
      true if item lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemQuery

      boolean supportsItemQuery()
      Tests if querying items is supported.
      Returns:
      true if item query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemSearch

      boolean supportsItemSearch()
      Tests if searching items is supported.
      Returns:
      true if item search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemAdmin

      boolean supportsItemAdmin()
      Tests if an item administrative service is supported.
      Returns:
      true if item administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemNotification

      boolean supportsItemNotification()
      Tests if an item notification service is supported.
      Returns:
      true if item notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemWarehouse

      boolean supportsItemWarehouse()
      Tests if an item cataloging service is supported.
      Returns:
      true if item catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemWarehouseAssignment

      boolean supportsItemWarehouseAssignment()
      Tests if an item cataloging service is supported. A cataloging service maps items to catalogs.
      Returns:
      true if item cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemSmartWarehouse

      boolean supportsItemSmartWarehouse()
      Tests if an item smart warehouse session is available.
      Returns:
      true if an item smart warehouse session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStockLookup

      boolean supportsStockLookup()
      Tests if looking up stocks is supported.
      Returns:
      true if stock lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStockQuery

      boolean supportsStockQuery()
      Tests if querying stocks is supported.
      Returns:
      true if stock query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStockSearch

      boolean supportsStockSearch()
      Tests if searching stocks is supported.
      Returns:
      true if stock search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStockAdmin

      boolean supportsStockAdmin()
      Tests if stock administrative service is supported.
      Returns:
      true if stock administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStockNotification

      boolean supportsStockNotification()
      Tests if a stock notification service is supported.
      Returns:
      true if stock notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStockWarehouse

      boolean supportsStockWarehouse()
      Tests if a stock cataloging service is supported.
      Returns:
      true if stock catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStockWarehouseAssignment

      boolean supportsStockWarehouseAssignment()
      Tests if a stock cataloging service is supported. A cataloging service maps stocks to catalogs.
      Returns:
      true if stock cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStockSmartWarehouse

      boolean supportsStockSmartWarehouse()
      Tests if a stock smart warehouse session is available.
      Returns:
      true if a stock smart warehouse session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStockHierarchy

      boolean supportsStockHierarchy()
      Tests for the availability of a stock hierarchy traversal service.
      Returns:
      true if stock hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsStockHierarchyDesign

      boolean supportsStockHierarchyDesign()
      Tests for the availability of a stock hierarchy design service.
      Returns:
      true if stock hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsModelLookup

      boolean supportsModelLookup()
      Tests if looking up models is supported.
      Returns:
      true if model lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsModelQuery

      boolean supportsModelQuery()
      Tests if querying models is supported.
      Returns:
      true if model query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsModelSearch

      boolean supportsModelSearch()
      Tests if searching models is supported.
      Returns:
      true if model search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsModelAdmin

      boolean supportsModelAdmin()
      Tests if a stock administrative service is supported.
      Returns:
      true if model administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsModelNotification

      boolean supportsModelNotification()
      Tests if a model notification service is supported.
      Returns:
      true if model notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsModelWarehouse

      boolean supportsModelWarehouse()
      Tests if a model cataloging service is supported.
      Returns:
      true if model catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsModelWarehouseAssignment

      boolean supportsModelWarehouseAssignment()
      Tests if a model cataloging service is supported. A cataloging service maps models to catalogs.
      Returns:
      true if model cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsModelSmartWarehouse

      boolean supportsModelSmartWarehouse()
      Tests if a model smart warehouse session is available.
      Returns:
      true if a model smart warehouse session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsInventoryLookup

      boolean supportsInventoryLookup()
      Tests if looking up inventories is supported.
      Returns:
      true if inventory lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsInventoryQuery

      boolean supportsInventoryQuery()
      Tests if querying inventories is supported.
      Returns:
      true if inventory query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsInventorySearch

      boolean supportsInventorySearch()
      Tests if searching inventories is supported.
      Returns:
      true if inventory search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsInventoryAdmin

      boolean supportsInventoryAdmin()
      Tests if inventory administrative service is supported.
      Returns:
      true if inventory administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsInventoryNotification

      boolean supportsInventoryNotification()
      Tests if an inventory notification service is supported.
      Returns:
      true if inventory notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsInventoryWarehouse

      boolean supportsInventoryWarehouse()
      Tests if an inventory cataloging service is supported.
      Returns:
      true if inventory catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsInventoryWarehouseAssignment

      boolean supportsInventoryWarehouseAssignment()
      Tests if an inventory cataloging service is supported. A cataloging service maps inventories to catalogs.
      Returns:
      true if inventory cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsInventorySmartWarehouse

      boolean supportsInventorySmartWarehouse()
      Tests if an inventory smart warehouse session is available.
      Returns:
      true if an inventory smart warehouse session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWarehouseLookup

      boolean supportsWarehouseLookup()
      Tests if looking up warehouses is supported.
      Returns:
      true if warehouse lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWarehouseSearch

      boolean supportsWarehouseSearch()
      Tests if searching warehouses is supported.
      Returns:
      true if warehouse search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWarehouseQuery

      boolean supportsWarehouseQuery()
      Tests if querying warehouses is supported.
      Returns:
      true if warehouse query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWarehouseAdmin

      boolean supportsWarehouseAdmin()
      Tests if warehouse administrative service is supported.
      Returns:
      true if warehouse administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWarehouseNotification

      boolean supportsWarehouseNotification()
      Tests if a warehouse notification service is supported.
      Returns:
      true if warehouse notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWarehouseHierarchy

      boolean supportsWarehouseHierarchy()
      Tests for the availability of a warehouse hierarchy traversal service.
      Returns:
      true if warehouse hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsWarehouseHierarchyDesign

      boolean supportsWarehouseHierarchyDesign()
      Tests for the availability of a warehouse hierarchy design service.
      Returns:
      true if warehouse hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsInventoryBatch

      boolean supportsInventoryBatch()
      Tests for the availability of an inventory batch service.
      Returns:
      true if an inventory batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsInventoryShipment

      boolean supportsInventoryShipment()
      Tests for the availability of an inventory shipment service.
      Returns:
      true if an inventory shipment service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getItemRecordTypes

      TypeList getItemRecordTypes()
      Gets the supported Item record types.
      Returns:
      a list containing the supported Item record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemRecordType

      boolean supportsItemRecordType(Type itemRecordType)
      Tests if the given Item record type is supported.
      Parameters:
      itemRecordType - a Type indicating an Item record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - itemRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getItemSearchRecordTypes

      TypeList getItemSearchRecordTypes()
      Gets the supported Item search record types.
      Returns:
      a list containing the supported Item search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsItemSearchRecordType

      boolean supportsItemSearchRecordType(Type itemSearchRecordType)
      Tests if the given Item search record type is supported.
      Parameters:
      itemSearchRecordType - a Type indicating an Item search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - itemSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getStockRecordTypes

      TypeList getStockRecordTypes()
      Gets the supported Stock record types.
      Returns:
      a list containing the supported Stock record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsStockRecordType

      boolean supportsStockRecordType(Type stockRecordType)
      Tests if the given Stock record type is supported.
      Parameters:
      stockRecordType - a Type indicating an Stock record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - stockRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getStockSearchRecordTypes

      TypeList getStockSearchRecordTypes()
      Gets the supported Stock search record types.
      Returns:
      a list containing the supported Stock search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsStockSearchRecordType

      boolean supportsStockSearchRecordType(Type stockSearchRecordType)
      Tests if the given Stock search record type is supported.
      Parameters:
      stockSearchRecordType - a Type indicating an Stock search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - stockSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getModelRecordTypes

      TypeList getModelRecordTypes()
      Gets the supported Model record types.
      Returns:
      a list containing the supported Model record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsModelRecordType

      boolean supportsModelRecordType(Type modelRecordType)
      Tests if the given Model record type is supported.
      Parameters:
      modelRecordType - a Type indicating an Model record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - modelRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getModelSearchRecordTypes

      TypeList getModelSearchRecordTypes()
      Gets the supported Model search record types.
      Returns:
      a list containing the supported Model search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsModelSearchRecordType

      boolean supportsModelSearchRecordType(Type modelSearchRecordType)
      Tests if the given Model search record type is supported.
      Parameters:
      modelSearchRecordType - a Type indicating an Model search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - modelSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getInventoryRecordTypes

      TypeList getInventoryRecordTypes()
      Gets the supported Inventory record types.
      Returns:
      a list containing the supported Inventory record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsInventoryRecordType

      boolean supportsInventoryRecordType(Type inventoryRecordType)
      Tests if the given Inventory record type is supported.
      Parameters:
      inventoryRecordType - a Type indicating an Inventory record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - inventoryRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getInventorySearchRecordTypes

      TypeList getInventorySearchRecordTypes()
      Gets the supported Inventory search record types.
      Returns:
      a list containing the supported Inventory search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsInventorySearchRecordType

      boolean supportsInventorySearchRecordType(Type inventorySearchRecordType)
      Tests if the given Inventory search record type is supported.
      Parameters:
      inventorySearchRecordType - a Type indicating an Inventory search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - inventorySearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getWarehouseRecordTypes

      TypeList getWarehouseRecordTypes()
      Gets the supported Warehouse record types.
      Returns:
      a list containing the supported Warehouse types
      Compliance:
      mandatory - This method must be implemented.

    • supportsWarehouseRecordType

      boolean supportsWarehouseRecordType(Type warehouseRecordType)
      Tests if the given Warehouse record type is supported.
      Parameters:
      warehouseRecordType - a Type indicating an Warehouse record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - warehouseRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getWarehouseSearchRecordTypes

      TypeList getWarehouseSearchRecordTypes()
      Gets the supported Warehouse search record types.
      Returns:
      a list containing the supported Warehouse search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsWarehouseSearchRecordType

      boolean supportsWarehouseSearchRecordType(Type warehouseSearchRecordType)
      Tests if the given Warehouse search record type is supported.
      Parameters:
      warehouseSearchRecordType - a Type indicating an Warehouse search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - warehousesearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.