Package org.openwms.wms.location

Interface LocationService

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

  • Method Details

    • findByForeignPKey

      @NotNull @NotNull Location findByForeignPKey(@NotBlank @NotBlank String foreignPKey)
      Find and return a Location identified by the persistent key.
      Parameters:
      foreignPKey - The foreign persistent key of the Location instance
      Returns:
      The instance

    • findOptionalByID

      Optional<Location> findOptionalByID(@NotNull @NotNull LocationPK locationId)
      Find and return the Location identified by the business key.
      Parameters:
      locationId - The coordinate of the Location
      Returns:
      The instance

    • findByBK

      @NotNull @NotNull Location findByBK(@NotNull @NotNull LocationPK locationId)
      Find and return the Location identified by the business key.
      Parameters:
      locationId - The coordinate of the Location
      Returns:
      The instance
      Throws:
      org.ameba.exception.NotFoundException - in case the Location does not exist

    • findByErpCode

      @NotNull @NotNull Location findByErpCode(@NotBlank @NotBlank String erpCode)
      Find and return the Location identified by the unique erpCode.
      Parameters:
      erpCode - The unique ERP code
      Returns:
      The instance
      Throws:
      org.ameba.exception.NotFoundException - in case the Location does not exist

    • findOptionalByErpCode

      Optional<Location> findOptionalByErpCode(@NotBlank @NotBlank String erpCode)
      Find and return the Location identified by the unique erpCode.
      Parameters:
      erpCode - The unique ERP code
      Returns:
      The instance

    • save

      @NotNull @NotNull Location save(@NotNull @NotNull Location location)
      Save a Location.
      Parameters:
      location - The instance to save
      Returns:
      The saved instance

    • isRemovalAllowed

      boolean isRemovalAllowed(@NotNull @NotNull List<String> foreignPKeys)
      Requests the removal of Locations identified by the foreign persistent keys.
      Parameters:
      foreignPKeys - The foreign persistent keys of the Locations to be deleted
      Returns:
      true if deletion of Locations is allowed

    • markForRemoval

      void markForRemoval(@NotNull @NotNull List<String> foreignPKeys)
      Mark Locations identified by the given keys for removal.
      Parameters:
      foreignPKeys - The foreign persistent keys of the Locations to be removed