de.hybris.platform.warehousingfacades.order

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 Type	Method and Description
void	confirmPickupConsignment(java.lang.String code) Confirm Consignment's pick up
void	confirmShipConsignment(java.lang.String code) Confirm Consignment's shipping
java.lang.String	consolidatedPickSlip(ConsignmentCodeDataList consignmentCodeDataList) API to print a consolidated pick list for the specified ConsignmentCodeDataList.
SearchPageData<ConsignmentEntryData>	getConsignmentEntriesForConsignmentCode(java.lang.String code, PageableData pageableData) API to get consignmentEntries for the given ConsignmentModel.CODE
ConsignmentData	getConsignmentForCode(java.lang.String code) API to return details of a single consignment according for the given ConsignmentModel.CODE.
PackagingInfoData	getConsignmentPackagingInformation(java.lang.String code) API to return the packaging information for the given ConsignmentModel.CODE.
SearchPageData<ConsignmentData>	getConsignments(PageableData pageableData) API to fetch all consignments in the system
SearchPageData<ConsignmentData>	getConsignmentsByStatuses(PageableData pageableData, java.util.Set<ConsignmentStatus> consignmentStatusSet) API to fetch all consignments in the system that have certain status(es)
java.util.List<ConsignmentStatus>	getConsignmentStatuses() API to return all consignment statuses
java.util.List<DeclineReason>	getDeclineReasons() API to return all decline reasons.
java.lang.String	getExportForm(java.lang.String code) API to get the export form of a ConsignmentModel
java.lang.String	getReturnForm(java.lang.String code) API to get the return form of a ConsignmentModel
java.lang.String	getReturnShippingLabel(java.lang.String code) API to get the return shipping label of a ConsignmentModel
java.lang.String	getShippingLabel(java.lang.String code) API to get the shipping label of a ConsignmentModel
SearchPageData<WarehouseData>	getSourcingLocationsForConsignmentCode(java.lang.String code, PageableData pageableData) API to return all warehouses fit for souring for the given ConsignmentModel.CODE.
boolean	isConsignmentConfirmable(java.lang.String code) Checks if the confirm ship/pickup is possible for the given ConsignmentModel.CODE
void	manuallyReleasePaymentCapture(java.lang.String code) API to manually release a ConsignmentModel after a payment capture failure
void	manuallyReleaseTaxCommit(java.lang.String code) API to manually release a ConsignmentModel after a tax commit failure
java.lang.String	packConsignment(java.lang.String code) API to pack a ConsignmentModel and its pack label
java.lang.String	packConsignment(java.lang.String code, boolean printSlip) API to pack a ConsignmentModel and optionally return its pack label
java.lang.String	pickConsignment(java.lang.String code) API to pick a ConsignmentModel and return its pick slip
java.lang.String	pickConsignment(java.lang.String code, boolean printSlip) API to pick a ConsignmentModel and optionally return its pick slip
void	reallocateConsignment(java.lang.String consignmentCode, ConsignmentReallocationData consignmentReallocationData) Reallocate the given consignment based on the given ConsignmentReallocationData
PaymentTransactionEntryData	takePayment(java.lang.String code) API to take payment for a ConsignmentModel
ConsignmentData	updateConsignmentPackagingInformation(java.lang.String code, PackagingInfoData packagingInfoData) API to update the packaging information for the given ConsignmentModel.CODE.

Method Detail

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,
                                                          java.util.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(java.lang.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(java.lang.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

java.util.List<ConsignmentStatus> getConsignmentStatuses()

API to return all consignment statuses

Returns:

list of ConsignmentStatus

getDeclineReasons

java.util.List<DeclineReason> getDeclineReasons()

API to return all decline reasons.

Returns:

a list of DeclineReason

getSourcingLocationsForConsignmentCode

SearchPageData<WarehouseData> getSourcingLocationsForConsignmentCode(java.lang.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(java.lang.String code)

Confirm Consignment's shipping

Parameters:

code - the ConsignmentModel.CODE for the ConsignmentModel to be shipped

confirmPickupConsignment

void confirmPickupConsignment(java.lang.String code)

Confirm Consignment's pick up

Parameters:

code - the ConsignmentModel.CODE for the ConsignmentModel to be picked up

isConsignmentConfirmable

boolean isConsignmentConfirmable(java.lang.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(java.lang.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(java.lang.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(java.lang.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

java.lang.String pickConsignment(java.lang.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

java.lang.String pickConsignment(java.lang.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

java.lang.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

java.lang.String packConsignment(java.lang.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

java.lang.String packConsignment(java.lang.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

java.lang.String getExportForm(java.lang.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

java.lang.String getShippingLabel(java.lang.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

java.lang.String getReturnShippingLabel(java.lang.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

java.lang.String getReturnForm(java.lang.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

PaymentTransactionEntryData takePayment(java.lang.String code)

API to take payment for a ConsignmentModel

Parameters:

code - the ConsignmentModel.CODE

Returns:

the PaymentTransactionEntryData with the recorded transaction

manuallyReleasePaymentCapture

void manuallyReleasePaymentCapture(java.lang.String code)

API to manually release a ConsignmentModel after a payment capture failure

Parameters:

code - the ConsignmentModel.CODE

manuallyReleaseTaxCommit

void manuallyReleaseTaxCommit(java.lang.String code)

API to manually release a ConsignmentModel after a tax commit failure

Parameters:

code - the ConsignmentModel.CODE