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 Summary
Modifier and TypeMethodDescriptionvoidConfirm Consignment's pick upvoidconfirmShipConsignment(String code) Confirm Consignment's shippingconsolidatedPickSlip(ConsignmentCodeDataList consignmentCodeDataList) API to print a consolidated pick list for the specifiedConsignmentCodeDataList.getConsignmentEntriesForConsignmentCode(String code, PageableData pageableData) API to get consignmentEntries for the givenConsignmentModel.CODEgetConsignmentForCode(String code) API to return details of a single consignment according for the givenConsignmentModel.CODE.API to return the packaging information for the givenConsignmentModel.CODE.getConsignments(PageableData pageableData) API to fetch all consignments in the systemgetConsignmentsByStatuses(PageableData pageableData, Set<ConsignmentStatus> consignmentStatusSet) API to fetch all consignments in the system that have certain status(es)API to return all consignment statusesAPI to return all decline reasons.getExportForm(String code) API to get the export form of aConsignmentModelgetReturnForm(String code) API to get the return form of aConsignmentModelgetReturnShippingLabel(String code) API to get the return shipping label of aConsignmentModelgetShippingLabel(String code) API to get the shipping label of aConsignmentModelgetSourcingLocationsForConsignmentCode(String code, PageableData pageableData) API to return all warehouses fit for souring for the givenConsignmentModel.CODE.booleanChecks if the confirm ship/pickup is possible for the givenConsignmentModel.CODEvoidAPI to manually release aConsignmentModelafter a payment capture failurevoidAPI to manually release aConsignmentModelafter a tax commit failurepackConsignment(String code) API to pack aConsignmentModeland its pack labelpackConsignment(String code, boolean printSlip) API to pack aConsignmentModeland optionally return its pack labelpickConsignment(String code) API to pick aConsignmentModeland return its pick slippickConsignment(String code, boolean printSlip) API to pick aConsignmentModeland optionally return its pick slipvoidreallocateConsignment(String consignmentCode, ConsignmentReallocationData consignmentReallocationData) Reallocate the given consignment based on the givenConsignmentReallocationDatatakePayment(String code) API to take payment for aConsignmentModelupdateConsignmentPackagingInformation(String code, PackagingInfoData packagingInfoData) API to update the packaging information for the givenConsignmentModel.CODE.
-
Method Details
-
getConsignments
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 infoconsignmentStatusSet- set ofConsignmentStatus, 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 givenConsignmentModel.CODE- Parameters:
code- the consignment's codepageableData- 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
API to return details of a single consignment according for the givenConsignmentModel.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 givenConsignmentModel.CODE.- Parameters:
code- the consignment codepageableData- 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
Confirm Consignment's shipping- Parameters:
code- theConsignmentModel.CODEfor theConsignmentModelto be shipped
-
confirmPickupConsignment
Confirm Consignment's pick up- Parameters:
code- theConsignmentModel.CODEfor theConsignmentModelto be picked up
-
isConsignmentConfirmable
Checks if the confirm ship/pickup is possible for the givenConsignmentModel.CODE- Parameters:
code- the code for the consignment to be confirmed- Returns:
- boolean to indicate if confirmation of the given consignment is possible
-
getConsignmentPackagingInformation
API to return the packaging information for the givenConsignmentModel.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 givenConsignmentModel.CODE.- Parameters:
code- the consignment code for which the packaging information will be updatedpackagingInfoData- 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 givenConsignmentReallocationData- Parameters:
consignmentCode- theConsignmentData.codewhich needs to be reallocatedconsignmentReallocationData- theConsignmentReallocationDatacontaining theDeclineEntryData
-
pickConsignment
API to pick aConsignmentModeland return its pick slip- Parameters:
code- theConsignmentModel.CODE- Returns:
- the generated HTML template for the pick slip
-
pickConsignment
API to pick aConsignmentModeland optionally return its pick slip- Parameters:
code- theConsignmentModel.CODEprintSlip- flag used to check if the pick slip should be returned- Returns:
- the generated HTML template for the pick slip or null
-
consolidatedPickSlip
API to print a consolidated pick list for the specifiedConsignmentCodeDataList. The API also performs the Pick operation on eachConsignmentModelin the list- Parameters:
consignmentCodeDataList- theConsignmentCodeDataListcontaining mulitpleConsignmentModel.CODE- Returns:
- the generated HTML template for the consolidated pick slip
-
packConsignment
API to pack aConsignmentModeland optionally return its pack label- Parameters:
code- theConsignmentModel.CODEprintSlip- flag used to check if the pack label should be returned- Returns:
- the optionally generated HTML template for the pack label
-
packConsignment
API to pack aConsignmentModeland its pack label- Parameters:
code- theConsignmentModel.CODE- Returns:
- the generated HTML template for the pack label
-
getExportForm
API to get the export form of aConsignmentModel- Parameters:
code- theConsignmentModel.CODE- Returns:
- the generated HTML template for the export form
-
getShippingLabel
API to get the shipping label of aConsignmentModel- Parameters:
code- theConsignmentModel.CODE- Returns:
- the generated HTML template for the shipping label
-
getReturnShippingLabel
API to get the return shipping label of aConsignmentModel- Parameters:
code- theConsignmentModel.CODE- Returns:
- the generated HTML template for the return shipping label
-
getReturnForm
API to get the return form of aConsignmentModel- Parameters:
code- theConsignmentModel.CODE- Returns:
- the generated HTML template for the return form
-
takePayment
API to take payment for aConsignmentModel- Parameters:
code- theConsignmentModel.CODE- Returns:
- the
PaymentTransactionEntryDatawith the recorded transaction
-
manuallyReleasePaymentCapture
API to manually release aConsignmentModelafter a payment capture failure- Parameters:
code- theConsignmentModel.CODE
-
manuallyReleaseTaxCommit
API to manually release aConsignmentModelafter a tax commit failure- Parameters:
code- theConsignmentModel.CODE
-