Package org.openwms.common.putaway.api

Interface PutawayApi

  • @FeignClient(name="common-service",
             qualifier="putawayApi",
             decode404=true)
public interface PutawayApi
    A PutawayApi.
    Author:
    Heiko Scherrer

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int countAvailableLocationsIn​(String locationGroupNames)
      Count and return the number of free stock locations in the LocationGroups identified by the given locationGroupNames.
      org.openwms.common.location.api.LocationVO findAndAssignNextInLocGroup​(String locationGroupName, String transportUnitBK)
      Find the next available location for infeed in the LocationGroup identified by the locationGroupName and assign the TransportUnit with the given business key to this target.
      List<org.openwms.common.location.api.LocationVO> findInAisle​(String locationGroupName, String transportUnitBK)
      Find proper stock locations for infeed in the LocationGroup identified by the locationGroupName.
      org.openwms.common.location.api.LocationVO findNextInAisle​(String locationGroupName, String transportUnitBK)
      Find the next stock location for infeed in the LocationGroup identified by the locationGroupName.

    • Method Detail

      • countAvailableLocationsIn

        @GetMapping(value="/v1/location-groups",
            params="locationGroupNames")
int countAvailableLocationsIn​(@RequestParam("locationGroupNames")
                              String locationGroupNames)
        Count and return the number of free stock locations in the LocationGroups identified by the given locationGroupNames.
        Parameters:
        locationGroupNames - A comma separated list of LocationGroup names
        Returns:
        The sum of all available Locations in all LocationGroups

      • findInAisle

        @GetMapping(value="/v1/location-groups",
            params={"locationGroupName","transportUnitBK"})
List<org.openwms.common.location.api.LocationVO> findInAisle​(@RequestParam("locationGroupName")
                                                             String locationGroupName,
                                                             @RequestParam("transportUnitBK")
                                                             String transportUnitBK)
        Find proper stock locations for infeed in the LocationGroup identified by the locationGroupName.
        Parameters:
        locationGroupName - Name of the LocationGroup to search Locations for
        transportUnitBK - The unique (physical) identifier of the TransportUnit to search a Location for
        Returns:
        Next free Location for infeed
        Throws:
        org.ameba.exception.NotFoundException - May throw in case no Location available

      • findNextInAisle

        @GetMapping(value="/v1/location-groups",
            params={"locationGroupName","transportUnitBK"},
            produces="application/vnd.openwms.location.single-v1+json")
org.openwms.common.location.api.LocationVO findNextInAisle​(@RequestParam("locationGroupName")
                                                           String locationGroupName,
                                                           @RequestParam("transportUnitBK")
                                                           String transportUnitBK)
        Find the next stock location for infeed in the LocationGroup identified by the locationGroupName.
        Parameters:
        locationGroupName - Name of the LocationGroup to search a Location for
        transportUnitBK - The unique (physical) identifier of the TransportUnit to search a Location for
        Returns:
        Next free Location for infeed
        Throws:
        org.ameba.exception.NotFoundException - May throw in case no Location available

      • findAndAssignNextInLocGroup

        @PostMapping(value="/v1/location-groups",
             params={"locationGroupName","transportUnitBK"},
             produces="application/vnd.openwms.location.single-v1+json")
org.openwms.common.location.api.LocationVO findAndAssignNextInLocGroup​(@RequestParam("locationGroupName")
                                                                       String locationGroupName,
                                                                       @RequestParam("transportUnitBK")
                                                                       String transportUnitBK)
        Find the next available location for infeed in the LocationGroup identified by the locationGroupName and assign the TransportUnit with the given business key to this target.
        Parameters:
        locationGroupName - Name of the LocationGroup to search a Location for
        transportUnitBK - The unique (physical) identifier of the TransportUnit to search a Location for
        Returns:
        Assigned Location for infeed
        Throws:
        org.ameba.exception.NotFoundException - May throw in case no Location available