Package org.openwms.wms.shipping

Interface ShippingService

All Known Implementing Classes:
ShippingServiceImpl
public interface ShippingService
A ShippingService.
Author:
Heiko Scherrer

  • Method Details

    • createOrder

      ShippingOrder createOrder(@NotNull @NotNull ShippingOrder order)
      Create a new ShippingOrder.
      Parameters:
      order - The ShippingOrder instance to store

    • changeState

      ShippingOrder changeState(@NotNull @NotNull ShippingOrder shippingOrder, @NotNull @NotNull OrderState orderState)
      Change the state of an existing ShippingOrder.
      Parameters:
      shippingOrder - The ShippingOrder instance to change the state for
      orderState - The new order state to set
      Returns:
      The updated instance

    • changeState

      ShippingOrderPosition changeState(@NotNull @NotNull ShippingOrderPosition shippingOrderPosition, @NotNull @NotNull OrderState orderState)
      Change the state of an existing ShippingOrderPosition.
      Parameters:
      shippingOrderPosition - The ShippingOrderPosition instance to change the state for
      orderState - The new order state to set
      Returns:
      The updated instance

    • findByPKey

      ShippingOrder findByPKey(@NotEmpty @NotEmpty String pKey)
      Find and return a ShippingOrder.
      Parameters:
      pKey - The persistent key of the ShippingOrder
      Returns:
      The instance
      Throws:
      org.ameba.exception.NotFoundException - if not exists

    • findByOrderId

      ShippingOrder findByOrderId(@NotEmpty @NotEmpty String orderId)
      Find and return a ShippingOrder.
      Parameters:
      orderId - The business key of the ShippingOrder
      Returns:
      The instance
      Throws:
      org.ameba.exception.NotFoundException - if not exists

    • findByPositionPKey

      ShippingOrder findByPositionPKey(@NotEmpty @NotEmpty String pKey)
      Find and return a ShippingOrder.
      Parameters:
      pKey - The persistent key of the order
      Returns:
      The instance, never null

    • updateOrderPartially

      ShippingOrder updateOrderPartially(@NotEmpty @NotEmpty String pKey, @NotNull @NotNull ShippingOrder shippingOrder)
      Partially update a single ShippingOrder.
      Parameters:
      pKey - The persistent key of the existing ShippingOrder
      shippingOrder - The partial content of the ShippingOrder
      Returns:
      The updated instance

    • updatePositionPartially

      ShippingOrderPosition updatePositionPartially(@NotEmpty @NotEmpty String pKey, @NotNull @NotNull ShippingOrderPosition shippingOrderPosition)
      Partially update a single ShippingOrderPosition.
      Parameters:
      pKey - The persistent key of the existing ShippingOrderPosition
      shippingOrderPosition - The partial content of the ShippingOrderPosition
      Returns:
      The updated instance