Package org.openwms.wms.inventory

Interface PackagingUnitFinder

All Known Implementing Classes:
PackagingUnitFinderImpl
public interface PackagingUnitFinder
A PackagingUnitFinder.
Author:
Heiko Scherrer

  • Method Details

    • findByPKey

      PackagingUnit findByPKey(@NotEmpty @NotEmpty String pKey)
      Find and return a PackagingUnit.
      Parameters:
      pKey - The persistent identifier
      Returns:
      The instance
      Throws:
      org.ameba.exception.NotFoundException - in case no PackagingUnit exists

    • findOnLocation

      @NotNull @NotNull List<PackagingUnit> findOnLocation(@NotBlank @NotBlank String erpCode)
      Find and return all PackagingUnits that are located on a Location.
      Parameters:
      erpCode - The business key of the Location the PackagingUnits are placed on
      Returns:
      A list of all PackagingUnits, never null

    • findInLocationGroup

      @NotNull @NotNull List<PackagingUnit> findInLocationGroup(@NotBlank @NotBlank String locationGroupName)
      Find and return all PackagingUnits that are located in the given LocationGroup.
      Parameters:
      locationGroupName - The business key of the LocationGroup the PackagingUnits are stored in
      Returns:
      A list of all PackagingUnits, never null

    • findOnTU

      @NotNull @NotNull List<PackagingUnit> findOnTU(@NotEmpty @NotEmpty String transportUnitBK)
      Find and return all PackagingUnits that are located on a TransportUnit.
      Parameters:
      transportUnitBK - The business key of the TransportUnit the PackagingUnits are carried on
      Returns:
      A list of all PackagingUnits, never null

    • findOnTUandLU

      @NotNull @NotNull List<PackagingUnit> findOnTUandLU(@NotEmpty @NotEmpty String transportUnitBK, @NotEmpty @NotEmpty String luPos)
      Find and return all PackagingUnits that are located on a TransportUnit within a particular LoadUnit.
      Parameters:
      transportUnitBK - The business key of the TransportUnit the PackagingUnits are carried on
      luPos - The position of the LoadUnit within the TransportUnit
      Returns:
      A list of all PackagingUnits, never null

    • findForSku

      @NotNull @NotNull List<PackagingUnit> findForSku(@NotEmpty @NotEmpty String sku)
      Find and return all PackagingUnits for the given SKU.
      Parameters:
      sku - The Products SKU
      Returns:
      A list of PackagingUnits, never null

    • findForSku

      @NotNull @NotNull List<PackagingUnit> findForSku(@NotEmpty @NotEmpty String sku, int amount, String sortDirection, String sortProperty)
      Find and return an amount of PackagingUnits for the given SKU.
      Parameters:
      sku - The Products SKU
      amount - The number of returned hits
      sortDirection - The sort direction either ASC or DESC or null
      sortProperty - The property to sort the result list or null
      Returns:
      A list of PackagingUnits, never null

    • findOfProductInLG

      @NotNull @NotNull List<PackagingUnit> findOfProductInLG(@NotBlank @NotBlank String productPKey, List<String> locationGroupNames, String sortDirection, String sortProperty)
      Find and return all PackagingUnits of a Product identified by the given productPKey that is located within a particular LocationGroup identified by the given locationGroupName.
      Parameters:
      productPKey - The Product persistent key
      locationGroupNames - The identifying names of the LocationGroups
      sortDirection - Either ASC or DESC
      sortProperty - The name of the property to sort for
      Returns:
      A list of PackagingUnits

    • findAmountOfProductByPKey

      @NotNull @NotNull org.openwms.core.units.api.Measurable findAmountOfProductByPKey(@NotBlank @NotBlank String productPKey, @NotBlank @NotBlank String locationGroupName)
      Find and return the quantity of all PackagingUnits.
      Parameters:
      productPKey - The Product's persistent key
      locationGroupName - The identifying name of the LocationGroup and children to search for
      Returns:
      The sum of quantities of all PackagingUnits
      Throws:
      org.ameba.exception.NotFoundException - In case no LocationGroup with the locationGroupName exists

    • findAmountOfProductBySKU

      @NotNull @NotNull org.openwms.core.units.api.Measurable findAmountOfProductBySKU(@NotBlank @NotBlank String sku, @NotBlank @NotBlank String locationGroupName)
      Find and return the quantity of all PackagingUnits.
      Parameters:
      sku - or the Product's SKU
      locationGroupName - The identifying name of the LocationGroup and children to search for
      Returns:
      The sum of quantities of all PackagingUnits
      Throws:
      org.ameba.exception.NotFoundException - In case no LocationGroup with the locationGroupName exists

    • findAmountOfProductBySKUOnLocation

      @NotNull @NotNull org.openwms.core.units.api.Measurable findAmountOfProductBySKUOnLocation(@NotBlank @NotBlank String sku, @NotBlank @NotBlank String locationErpCode)
      Find and return the quantity of all PackagingUnits.
      Parameters:
      sku - or the Product's SKU
      locationErpCode - The identifying name of the Location to search for
      Returns:
      The sum of quantities of all PackagingUnits
      Throws:
      org.ameba.exception.NotFoundException - In case no Location with the erpCode exists

    • findAvailablesForProductOnLocationsOnly

      @NotNull @NotNull List<PackagingUnit> findAvailablesForProductOnLocationsOnly(@NotNull @NotNull Product product)

    • findAvailablesForProductInLoadUnitsOnly

      @NotNull @NotNull List<PackagingUnit> findAvailablesForProductInLoadUnitsOnly(@NotNull @NotNull Product product)