Interface WarehousingConsignmentFacade

All Known Implementing Classes:
DefaultWarehousingConsignmentFacade

public interface WarehousingConsignmentFacade
Warehousing Facade for the ConsignmentModel, which provides the basic CRUD features for the ConsignmentModel
  • Method Details

    • getConsignments

      SearchPageData<ConsignmentData> getConsignments(PageableData pageableData)
      API to fetch all consignments in the system
      Parameters:
      pageableData - pageable object that contains info on the number or pages and how many items in each page in addition the sorting info
      Returns:
      list of consignments
    • getConsignmentsByStatuses

      SearchPageData<ConsignmentData> getConsignmentsByStatuses(PageableData pageableData, Set<ConsignmentStatus> consignmentStatusSet)
      API to fetch all consignments in the system that have certain status(es)
      Parameters:
      pageableData - pageable object that contains info on the number or pages and how many items in each page in addition the sorting info
      consignmentStatusSet - set of ConsignmentStatus, in which we want to get list of consignments for
      Returns:
      list of consignments that complies with passed consignment status(es)
    • getConsignmentEntriesForConsignmentCode

      SearchPageData<ConsignmentEntryData> getConsignmentEntriesForConsignmentCode(String code, PageableData pageableData)
      API to get consignmentEntries for the given ConsignmentModel.CODE
      Parameters:
      code - the consignment's code
      pageableData - pageable object that contains info on the number or pages and how many items in each page in addition the sorting info
      Returns:
      SearchPageData that contains a list of the consignmentEntries for the given consignment
    • getConsignmentForCode

      ConsignmentData getConsignmentForCode(String code)
      API to return details of a single consignment according for the given ConsignmentModel.CODE.
      Parameters:
      code - the consignment's code.
      Returns:
      Consignment details for the given consignment code
    • getConsignmentStatuses

      List<ConsignmentStatus> getConsignmentStatuses()
      API to return all consignment statuses
      Returns:
      list of ConsignmentStatus
    • getDeclineReasons

      List<DeclineReason> getDeclineReasons()
      API to return all decline reasons.
      Returns:
      a list of DeclineReason
    • getSourcingLocationsForConsignmentCode

      SearchPageData<WarehouseData> getSourcingLocationsForConsignmentCode(String code, PageableData pageableData)
      API to return all warehouses fit for souring for the given ConsignmentModel.CODE.
      Parameters:
      code - the consignment code
      pageableData - pageable object that contains info on the number or pages and how many items in each page in addition the sorting info
      Returns:
      SearchPageData that contains a list of locations fit for sourcing
    • confirmShipConsignment

      void confirmShipConsignment(String code)
      Confirm Consignment's shipping
      Parameters:
      code - the ConsignmentModel.CODE for the ConsignmentModel to be shipped
    • confirmPickupConsignment

      void confirmPickupConsignment(String code)
      Confirm Consignment's pick up
      Parameters:
      code - the ConsignmentModel.CODE for the ConsignmentModel to be picked up
    • isConsignmentConfirmable

      boolean isConsignmentConfirmable(String code)
      Checks if the confirm ship/pickup is possible for the given ConsignmentModel.CODE
      Parameters:
      code - the code for the consignment to be confirmed
      Returns:
      boolean to indicate if confirmation of the given consignment is possible
    • getConsignmentPackagingInformation

      PackagingInfoData getConsignmentPackagingInformation(String code)
      API to return the packaging information for the given ConsignmentModel.CODE.
      Parameters:
      code - the consignment code for which to retrieve the packaging information
      Returns:
      the PackagingInfoData
    • updateConsignmentPackagingInformation

      ConsignmentData updateConsignmentPackagingInformation(String code, PackagingInfoData packagingInfoData)
      API to update the packaging information for the given ConsignmentModel.CODE.
      Parameters:
      code - the consignment code for which the packaging information will be updated
      packagingInfoData - the new packaging information with which to update the consignment
      Returns:
      the updated ConsignmentData
    • reallocateConsignment

      void reallocateConsignment(String consignmentCode, ConsignmentReallocationData consignmentReallocationData)
      Reallocate the given consignment based on the given ConsignmentReallocationData
      Parameters:
      consignmentCode - the ConsignmentData.code which needs to be reallocated
      consignmentReallocationData - the ConsignmentReallocationData containing the DeclineEntryData
    • pickConsignment

      String pickConsignment(String code)
      API to pick a ConsignmentModel and return its pick slip
      Parameters:
      code - the ConsignmentModel.CODE
      Returns:
      the generated HTML template for the pick slip
    • pickConsignment

      String pickConsignment(String code, boolean printSlip)
      API to pick a ConsignmentModel and optionally return its pick slip
      Parameters:
      code - the ConsignmentModel.CODE
      printSlip - flag used to check if the pick slip should be returned
      Returns:
      the generated HTML template for the pick slip or null
    • consolidatedPickSlip

      String consolidatedPickSlip(ConsignmentCodeDataList consignmentCodeDataList)
      API to print a consolidated pick list for the specified ConsignmentCodeDataList. The API also performs the Pick operation on each ConsignmentModel in the list
      Parameters:
      consignmentCodeDataList - the ConsignmentCodeDataList containing mulitple ConsignmentModel.CODE
      Returns:
      the generated HTML template for the consolidated pick slip
    • packConsignment

      String packConsignment(String code, boolean printSlip)
      API to pack a ConsignmentModel and optionally return its pack label
      Parameters:
      code - the ConsignmentModel.CODE
      printSlip - flag used to check if the pack label should be returned
      Returns:
      the optionally generated HTML template for the pack label
    • packConsignment

      String packConsignment(String code)
      API to pack a ConsignmentModel and its pack label
      Parameters:
      code - the ConsignmentModel.CODE
      Returns:
      the generated HTML template for the pack label
    • getExportForm

      String getExportForm(String code)
      API to get the export form of a ConsignmentModel
      Parameters:
      code - the ConsignmentModel.CODE
      Returns:
      the generated HTML template for the export form
    • getShippingLabel

      String getShippingLabel(String code)
      API to get the shipping label of a ConsignmentModel
      Parameters:
      code - the ConsignmentModel.CODE
      Returns:
      the generated HTML template for the shipping label
    • getReturnShippingLabel

      String getReturnShippingLabel(String code)
      API to get the return shipping label of a ConsignmentModel
      Parameters:
      code - the ConsignmentModel.CODE
      Returns:
      the generated HTML template for the return shipping label
    • getReturnForm

      String getReturnForm(String code)
      API to get the return form of a ConsignmentModel
      Parameters:
      code - the ConsignmentModel.CODE
      Returns:
      the generated HTML template for the return form
    • takePayment

      API to take payment for a ConsignmentModel
      Parameters:
      code - the ConsignmentModel.CODE
      Returns:
      the PaymentTransactionEntryData with the recorded transaction
    • manuallyReleasePaymentCapture

      void manuallyReleasePaymentCapture(String code)
      API to manually release a ConsignmentModel after a payment capture failure
      Parameters:
      code - the ConsignmentModel.CODE
    • manuallyReleaseTaxCommit

      void manuallyReleaseTaxCommit(String code)
      API to manually release a ConsignmentModel after a tax commit failure
      Parameters:
      code - the ConsignmentModel.CODE