Interface WarehousingPointOfServiceFacade

All Known Implementing Classes:
DefaultWarehousingPointOfServiceFacade

public interface WarehousingPointOfServiceFacade
Warehousing facade exposing CRUD operations on PointOfServiceModel
  • Method Details

    • getPointOfServiceByName

      PointOfServiceData getPointOfServiceByName(String posName)
      API to get a point of service by posName
      Parameters:
      posName - the point of service's posName
      Returns:
      the point of service
    • getWarehousesForPointOfService

      SearchPageData<WarehouseData> getWarehousesForPointOfService(PageableData pageableData, String posName)
      API to get all WarehouseModel in the system, for the given PointOfServiceModel.NAME
      Parameters:
      pageableData - pageable object that contains info on the number or pages and how many items in each page in addition the sorting info
      posName - the posName of the PointOfService for which warehouses are being retrieved
      Returns:
      the list of warehouses for the given PointOfService
    • updatePointOfServiceWithWarehouses

      PointOfServiceData updatePointOfServiceWithWarehouses(String posName, WarehouseCodesDataList warehouseCodes)
      API to update a PointOfServiceModel with a list of warehouses
      Parameters:
      posName - the posName of the PointOfService for which warehouses will be deleted
      warehouseCodes - the object containing the list of warehouse codes to add to the point of service
      Returns:
      the updated PointOfServiceData without the specified warehouses
    • deleteWarehouseFromPointOfService

      PointOfServiceData deleteWarehouseFromPointOfService(String posName, String warehouseCode)
      API to delete warehouses from PointOfServiceModel
      Parameters:
      posName - the posName of the PointOfService for which warehouses will be deleted
      warehouseCode - the warehouse which has to be removed from the point of service.
      Returns:
      the updated PointOfServiceData without the specified warehouses
    • updatePointOfServiceWithAddress

      PointOfServiceData updatePointOfServiceWithAddress(String posName, AddressData addressData)
      API to update a PointOfServiceModel
      Parameters:
      posName - the posName of POS that we want to update
      addressData - the address which we want to update the pos with
      Returns:
      the PointOfServiceData updated with the passed address and converted from the newly updated PointOfServiceModel