Package org.openwms.common.location

Interface LocationService

All Known Implementing Classes:
LocationServiceImpl
public interface LocationService
A LocationService manages Locations.
Author:
Heiko Scherrer

  • Method Details

    • create

      @NotNull @NotNull Location create(@NotNull @Valid @NotNull @Valid Location location)
      Create a new non-existing Location.
      Parameters:
      location - The representation with the mandatory data to create the Location
      Returns:
      The created instance

    • findByPKey

      @NotNull @NotNull Location findByPKey(@NotBlank @NotBlank String pKey)
      Find and return a Location.
      Parameters:
      pKey - The persistent key
      Returns:
      The instance
      Throws:
      org.ameba.exception.NotFoundException - If the Location does not exist

    • findByLocationPk

      Optional<Location> findByLocationPk(@NotNull @NotNull LocationPK locationId)
      Find and return a Location.
      Parameters:
      locationId - The business key of the Location to search for as String
      Returns:
      The Location instance

    • findByLocationId

      Optional<Location> findByLocationId(@NotBlank @NotBlank String locationId)
      Find and return a Location.
      Parameters:
      locationId - The business key of the Location to search for as String
      Returns:
      The Location instance

    • findByLocationIdOrThrow

      @NotNull @NotNull Location findByLocationIdOrThrow(@NotBlank @NotBlank String locationId)
      Find and return a Location.
      Parameters:
      locationId - The business key of the Location to search for as String
      Returns:
      The Location instance
      Throws:
      org.ameba.exception.NotFoundException - In case the Location does not exist

    • findLocations

      @NotNull @NotNull List<Location> findLocations(@NotNull @NotNull LocationPK locationIds)
      Find and return all Locations that match the locationIds whereas the attributes of the LocationPK may include SQL wildcard operators, like '%', '_'.
      Parameters:
      locationIds - The business keys of the Locations to search for as Strings
      Returns:
      The Location instances or an empty list, never null

    • findByErpCode

      Optional<Location> findByErpCode(@NotBlank @NotBlank String erpCode)
      Find and return a Location.
      Parameters:
      erpCode - The ERP Code of the Location to search for
      Returns:
      The Location instance

    • findByPlcCode

      Optional<Location> findByPlcCode(@NotBlank @NotBlank String plcCode)
      Find and return a Location.
      Parameters:
      plcCode - The PLC Code of the Location to search for
      Returns:
      The Location instance

    • findAllOf

      @NotNull @NotNull List<Location> findAllOf(@NotEmpty @NotEmpty List<String> locationGroupNames)
      Find and return all Locations that belong to a LocationGroup.
      Parameters:
      locationGroupNames - The identifying names of the LocationGroups to search Locations for
      Returns:
      The LocationGroup instances or an empty list, never null

    • changeState

      void changeState(@NotBlank @NotBlank String pKey, @NotNull @NotNull ErrorCodeVO errorCode)
      Change the infeed and outfeed state of a Location in respect of the according LocationGroup.
      Parameters:
      pKey - The persistent key identifier of the Location to change
      errorCode - Contains the error bitmap to encode the state

    • changeState

      void changeState(@NotNull @NotNull LocationPK bk, @NotNull @NotNull ErrorCodeVO errorCode)
      Change the infeed and outfeed state of a Location in respect of the according LocationGroup.
      Parameters:
      bk - The business key identifier of the Location to change
      errorCode - Contains the error bitmap to encode the state

    • save

      @NotNull @NotNull Location save(@NotNull @NotNull Location location)
      Modify and update an existing Location.
      Parameters:
      location - Modified instance
      Returns:
      Saved instance
      Throws:
      org.ameba.exception.NotFoundException - If the passed instance does not already exist