Package de.hybris.platform.warehousingfacades.order.impl

Class DefaultWarehousingConsignmentFacade

java.lang.Object

de.hybris.platform.ordermanagementfacades.OmsBaseFacade

de.hybris.platform.warehousingfacades.order.impl.DefaultWarehousingConsignmentFacade

All Implemented Interfaces:

WarehousingConsignmentFacade

public class DefaultWarehousingConsignmentFacade
extends OmsBaseFacade
implements WarehousingConsignmentFacade

Default implementation of WarehousingConsignmentFacade.

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	CAPTURE_PAYMENT_ON_CONSIGNMENT
protected static java.lang.String	CONSIGNMENT_ACTION_EVENT_NAME
protected static java.lang.String	CONSOLIDATED_PICK_SLIP_DOCUMENT_TEMPLATE
protected static java.lang.String	DECLINE_ENTRIES
protected static java.lang.String	EXPORT_FORM_DOCUMENT_TEMPLATE
protected static java.lang.String	HANDLE_MANUAL_PAYMENT_CAPTURE_CHOICE
protected static java.lang.String	HANDLE_MANUAL_TAX_COMMIT_CHOICE
protected static java.lang.String	PACK_CONSIGNMENT_CHOICE
protected static java.lang.String	PACK_SLIP_DOCUMENT_TEMPLATE
protected static java.lang.String	PACKING_TEMPLATE_CODE
protected static java.lang.String	PICK_SLIP_DOCUMENT_TEMPLATE
protected static java.lang.String	PICKING_TEMPLATE_CODE
protected static java.lang.String	REALLOCATE_CONSIGNMENT_CHOICE
protected static java.lang.String	RETURN_FORM_DOCUMENT_TEMPLATE
protected static java.lang.String	RETURN_SHIPPING_LABEL_DOCUMENT_TEMPLATE
protected static java.lang.String	SHIPPING_LABEL_DOCUMENT_TEMPLATE

Constructor Summary

Constructors

Constructor	Description
DefaultWarehousingConsignmentFacade()

Method Summary

Modifier and Type	Method	Description
protected void	buildDeclineParam(ConsignmentProcessModel processModel, java.util.List<DeclineEntry> entriesToReallocate)	Build and save the context parameter for decline entries and set it into the given process
protected void	cleanDeclineParam(ConsignmentProcessModel processModel)	Removes the old decline entries from BusinessProcessModel.CONTEXTPARAMETERS(if any exists), before attempting to decline
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.
protected BusinessProcessModel	generateBusinessProcess(java.util.List<ConsignmentModel> consignmentModels)	Generates a dummy BusinessProcessModel with a List so that it can be passed to the PrintMediaService
protected java.lang.String	generateMediaTemplate(java.lang.String code, java.lang.String template)	Generates a media template for the given ConsignmentModel.CODE and velocity template
protected ConfigurationService	getConfigurationService()
protected ConsignmentAmountCalculationStrategy	getConsignmentAmountCalculationStrategy()
protected WarehousingBusinessProcessService<ConsignmentModel>	getConsignmentBusinessProcessService()
protected Converter<ConsignmentModel,ConsignmentData>	getConsignmentConverter()
SearchPageData<ConsignmentEntryData>	getConsignmentEntriesForConsignmentCode(java.lang.String code, PageableData pageableData)	API to get consignmentEntries for the given ConsignmentModel.CODE
protected Converter<ConsignmentEntryModel,ConsignmentEntryData>	getConsignmentEntryConverter()
protected PagedGenericDao	getConsignmentEntryPagedDao()
ConsignmentData	getConsignmentForCode(java.lang.String code)	API to return details of a single consignment according for the given ConsignmentModel.CODE.
protected GenericDao<ConsignmentModel>	getConsignmentGenericDao()
protected ConsignmentModel	getConsignmentModelForCode(java.lang.String code)	Finds ConsignmentModel for the given ConsignmentModel.CODE
PackagingInfoData	getConsignmentPackagingInformation(java.lang.String code)	API to return the packaging information for the given ConsignmentModel.CODE.
protected PagedGenericDao<ConsignmentModel>	getConsignmentPagedGenericDao()
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)
protected SearchByStatusPagedGenericDao<ConsignmentModel>	getConsignmentSearchByStatusPagedDao()
java.util.List<ConsignmentStatus>	getConsignmentStatuses()	API to return all consignment statuses
java.util.List<DeclineReason>	getDeclineReasons()	API to return all decline reasons.
protected EnumerationService	getEnumerationService()
java.lang.String	getExportForm(java.lang.String code)	API to get the export form of a ConsignmentModel
protected Converter<PackagingInfoModel,PackagingInfoData>	getPackagingInfoConverter()
protected PaymentService	getPaymentService()
protected Converter<PaymentTransactionEntryModel,PaymentTransactionEntryData>	getPaymentTransactionEntryConverter()
protected PrintMediaService	getPrintMediaService()
protected java.util.List<ConsignmentStatus>	getReallocableConsignmentStatusList()
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
protected Converter<PackagingInfoData,PackagingInfoModel>	getReversePackagingInfoConverter()
java.lang.String	getShippingLabel(java.lang.String code)	API to get the shipping label of a ConsignmentModel
protected SourcingFilterProcessor	getSourcingFilterProcessor()
SearchPageData<WarehouseData>	getSourcingLocationsForConsignmentCode(java.lang.String code, PageableData pageableData)	API to return all warehouses fit for souring for the given ConsignmentModel.CODE.
protected java.util.List<WarehouseModel>	getSublistOfSourcingLocations(PageableData pageableData, java.util.List<WarehouseModel> locations)	Gets a sub list based on the pageable data object from the list containing all warehouses.
protected Converter<WarehouseModel,WarehouseData>	getWarehouseConverter()
WarehouseService	getWarehouseService()
protected WarehouseStockService	getWarehouseStockService()
protected WarehousingConsignmentWorkflowService	getWarehousingConsignmentWorkflowService()
protected WarehousingShippingService	getWarehousingShippingService()
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
protected java.lang.String	packConsignment(ConsignmentModel consignmentModel, boolean printSlip)	Performs common logic for packing a ConsignmentModel
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
protected PaymentTransactionEntryModel	performPaymentCapture(ConsignmentModel consignmentModel)	Performs the payment capture operation for the given ConsignmentModel
protected void	performPickWorkflowAction(ConsignmentModel consignmentModel)	Performs the Pick WorkflowActionModel for the given ConsignmentModel if the action has not been performed yet.
protected void	performPickWorkflowAction(ConsignmentModel consignmentModel, boolean printSlip)	Performs the Pick WorkflowActionModel for the given ConsignmentModel if the action has not been performed yet.
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
protected DeclineEntry	populateDeclineEntry(DeclineEntryData declineEntryData, ConsignmentReallocationData consignmentReallocationData, ConsignmentEntryModel consignmentEntryModel)	Populates and returns DeclineEntry from given DeclineEntryData
void	reallocateConsignment(java.lang.String consignmentCode, ConsignmentReallocationData consignmentReallocationData)	Reallocate the given consignment based on the given ConsignmentReallocationData
void	setConfigurationService(ConfigurationService configurationService)
void	setConsignmentAmountCalculationStrategy(ConsignmentAmountCalculationStrategy consignmentAmountCalculationStrategy)
void	setConsignmentBusinessProcessService(WarehousingBusinessProcessService<ConsignmentModel> consignmentBusinessProcessService)
void	setConsignmentConverter(Converter<ConsignmentModel,ConsignmentData> consignmentConverter)
void	setConsignmentEntryConverter(Converter<ConsignmentEntryModel,ConsignmentEntryData> consignmentEntryConverter)
void	setConsignmentEntryPagedDao(PagedGenericDao consignmentEntryPagedDao)
void	setConsignmentGenericDao(GenericDao<ConsignmentModel> consignmentGenericDao)
void	setConsignmentPagedGenericDao(PagedGenericDao<ConsignmentModel> consignmentPagedGenericDao)
void	setConsignmentSearchByStatusPagedDao(SearchByStatusPagedGenericDao<ConsignmentModel> consignmentSearchByStatusPagedDao)
void	setEnumerationService(EnumerationService enumerationService)
void	setPackagingInfoConverter(Converter<PackagingInfoModel,PackagingInfoData> packagingInfoConverter)
void	setPaymentService(PaymentService paymentService)
void	setPaymentTransactionEntryConverter(Converter<PaymentTransactionEntryModel,PaymentTransactionEntryData> paymentTransactionEntryConverter)
void	setPrintMediaService(PrintMediaService printMediaService)
void	setReallocableConsignmentStatusList(java.util.List<ConsignmentStatus> reallocableConsignmentStatusList)
void	setReversePackagingInfoConverter(Converter<PackagingInfoData,PackagingInfoModel> reversePackagingInfoConverter)
void	setSourcingFilterProcessor(SourcingFilterProcessor sourcingFilterProcessor)
void	setWarehouseConverter(Converter<WarehouseModel,WarehouseData> warehouseConverter)
void	setWarehouseService(WarehouseService warehouseService)
void	setWarehouseStockService(WarehouseStockService warehouseStockService)
void	setWarehousingConsignmentWorkflowService(WarehousingConsignmentWorkflowService warehousingConsignmentWorkflowService)
void	setWarehousingShippingService(WarehousingShippingService warehousingShippingService)
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.
protected void	validateDeclineEntryDataToReallocate(ConsignmentReallocationData consignmentReallocationData, DeclineEntryData declineEntryData, ConsignmentEntryModel consignmentEntry)	Validation for DeclineEntryData to be reallocated against given ConsignmentEntryModel.

Methods inherited from class de.hybris.platform.ordermanagementfacades.OmsBaseFacade

convertSearchPageData, createPaginationData, discardOrderSnapshot, getModelService, getOrderGenericDao, getOrderModelForCode, setModelService, setOrderGenericDao

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONSIGNMENT_ACTION_EVENT_NAME

protected static final java.lang.String CONSIGNMENT_ACTION_EVENT_NAME

See Also:

Constant Field Values

REALLOCATE_CONSIGNMENT_CHOICE

protected static final java.lang.String REALLOCATE_CONSIGNMENT_CHOICE

See Also:

Constant Field Values

DECLINE_ENTRIES

protected static final java.lang.String DECLINE_ENTRIES

See Also:

Constant Field Values

PICK_SLIP_DOCUMENT_TEMPLATE

protected static final java.lang.String PICK_SLIP_DOCUMENT_TEMPLATE

See Also:

Constant Field Values

PICKING_TEMPLATE_CODE

protected static final java.lang.String PICKING_TEMPLATE_CODE

See Also:

Constant Field Values

CONSOLIDATED_PICK_SLIP_DOCUMENT_TEMPLATE

protected static final java.lang.String CONSOLIDATED_PICK_SLIP_DOCUMENT_TEMPLATE

See Also:

Constant Field Values

PACK_SLIP_DOCUMENT_TEMPLATE

protected static final java.lang.String PACK_SLIP_DOCUMENT_TEMPLATE

See Also:

Constant Field Values

PACKING_TEMPLATE_CODE

protected static final java.lang.String PACKING_TEMPLATE_CODE

See Also:

Constant Field Values

PACK_CONSIGNMENT_CHOICE

protected static final java.lang.String PACK_CONSIGNMENT_CHOICE

See Also:

Constant Field Values

EXPORT_FORM_DOCUMENT_TEMPLATE

protected static final java.lang.String EXPORT_FORM_DOCUMENT_TEMPLATE

See Also:

Constant Field Values

SHIPPING_LABEL_DOCUMENT_TEMPLATE

protected static final java.lang.String SHIPPING_LABEL_DOCUMENT_TEMPLATE

See Also:

Constant Field Values

RETURN_SHIPPING_LABEL_DOCUMENT_TEMPLATE

protected static final java.lang.String RETURN_SHIPPING_LABEL_DOCUMENT_TEMPLATE

See Also:

Constant Field Values

RETURN_FORM_DOCUMENT_TEMPLATE

protected static final java.lang.String RETURN_FORM_DOCUMENT_TEMPLATE

See Also:

Constant Field Values

CAPTURE_PAYMENT_ON_CONSIGNMENT

protected static final java.lang.String CAPTURE_PAYMENT_ON_CONSIGNMENT

See Also:

Constant Field Values

HANDLE_MANUAL_PAYMENT_CAPTURE_CHOICE

protected static final java.lang.String HANDLE_MANUAL_PAYMENT_CAPTURE_CHOICE

See Also:

Constant Field Values

HANDLE_MANUAL_TAX_COMMIT_CHOICE

protected static final java.lang.String HANDLE_MANUAL_TAX_COMMIT_CHOICE

See Also:

Constant Field Values

Constructor Detail

DefaultWarehousingConsignmentFacade

public DefaultWarehousingConsignmentFacade()

Method Detail

getConsignments

public SearchPageData<ConsignmentData> getConsignments(PageableData pageableData)

Description copied from interface: WarehousingConsignmentFacade

API to fetch all consignments in the system

Specified by:

getConsignments in interface WarehousingConsignmentFacade

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

public SearchPageData<ConsignmentData> getConsignmentsByStatuses(PageableData pageableData,
                                                                 java.util.Set<ConsignmentStatus> consignmentStatusSet)

Description copied from interface: WarehousingConsignmentFacade

API to fetch all consignments in the system that have certain status(es)

Specified by:

getConsignmentsByStatuses in interface WarehousingConsignmentFacade

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

public SearchPageData<ConsignmentEntryData> getConsignmentEntriesForConsignmentCode(java.lang.String code,
                                                                                    PageableData pageableData)

Description copied from interface: WarehousingConsignmentFacade

API to get consignmentEntries for the given ConsignmentModel.CODE

Specified by:

getConsignmentEntriesForConsignmentCode in interface WarehousingConsignmentFacade

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

public ConsignmentData getConsignmentForCode(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

API to return details of a single consignment according for the given ConsignmentModel.CODE.

Specified by:

getConsignmentForCode in interface WarehousingConsignmentFacade

Parameters:

code - the consignment's code.

Returns:

Consignment details for the given consignment code

getConsignmentStatuses

public java.util.List<ConsignmentStatus> getConsignmentStatuses()

Description copied from interface: WarehousingConsignmentFacade

API to return all consignment statuses

Specified by:

getConsignmentStatuses in interface WarehousingConsignmentFacade

Returns:

list of ConsignmentStatus

getDeclineReasons

public java.util.List<DeclineReason> getDeclineReasons()

Description copied from interface: WarehousingConsignmentFacade

API to return all decline reasons.

Specified by:

getDeclineReasons in interface WarehousingConsignmentFacade

Returns:

a list of DeclineReason

getSourcingLocationsForConsignmentCode

public SearchPageData<WarehouseData> getSourcingLocationsForConsignmentCode(java.lang.String code,
                                                                            PageableData pageableData)

Description copied from interface: WarehousingConsignmentFacade

API to return all warehouses fit for souring for the given ConsignmentModel.CODE.

Specified by:

getSourcingLocationsForConsignmentCode in interface WarehousingConsignmentFacade

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

public void confirmShipConsignment(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

Confirm Consignment's shipping

Specified by:

confirmShipConsignment in interface WarehousingConsignmentFacade

Parameters:

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

confirmPickupConsignment

public void confirmPickupConsignment(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

Confirm Consignment's pick up

Specified by:

confirmPickupConsignment in interface WarehousingConsignmentFacade

Parameters:

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

isConsignmentConfirmable

public boolean isConsignmentConfirmable(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

Checks if the confirm ship/pickup is possible for the given ConsignmentModel.CODE

Specified by:

isConsignmentConfirmable in interface WarehousingConsignmentFacade

Parameters:

code - the code for the consignment to be confirmed

Returns:

boolean to indicate if confirmation of the given consignment is possible

getConsignmentPackagingInformation

public PackagingInfoData getConsignmentPackagingInformation(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

API to return the packaging information for the given ConsignmentModel.CODE.

Specified by:

getConsignmentPackagingInformation in interface WarehousingConsignmentFacade

Parameters:

code - the consignment code for which to retrieve the packaging information

Returns:

the PackagingInfoData

updateConsignmentPackagingInformation

public ConsignmentData updateConsignmentPackagingInformation(java.lang.String code,
                                                             PackagingInfoData packagingInfoData)

Description copied from interface: WarehousingConsignmentFacade

API to update the packaging information for the given ConsignmentModel.CODE.

Specified by:

updateConsignmentPackagingInformation in interface WarehousingConsignmentFacade

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

public void reallocateConsignment(java.lang.String consignmentCode,
                                  ConsignmentReallocationData consignmentReallocationData)

Description copied from interface: WarehousingConsignmentFacade

Reallocate the given consignment based on the given ConsignmentReallocationData

Specified by:

reallocateConsignment in interface WarehousingConsignmentFacade

Parameters:

consignmentCode - the ConsignmentData.code which needs to be reallocated

consignmentReallocationData - the ConsignmentReallocationData containing the DeclineEntryData

pickConsignment

public java.lang.String pickConsignment(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

API to pick a ConsignmentModel and return its pick slip

Specified by:

pickConsignment in interface WarehousingConsignmentFacade

Parameters:

code - the ConsignmentModel.CODE

Returns:

the generated HTML template for the pick slip

pickConsignment

public java.lang.String pickConsignment(java.lang.String code,
                                        boolean printSlip)

Description copied from interface: WarehousingConsignmentFacade

API to pick a ConsignmentModel and optionally return its pick slip

Specified by:

pickConsignment in interface WarehousingConsignmentFacade

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

public java.lang.String consolidatedPickSlip(ConsignmentCodeDataList consignmentCodeDataList)

Description copied from interface: WarehousingConsignmentFacade

API to print a consolidated pick list for the specified ConsignmentCodeDataList. The API also performs the Pick operation on each ConsignmentModel in the list

Specified by:

consolidatedPickSlip in interface WarehousingConsignmentFacade

Parameters:

consignmentCodeDataList - the ConsignmentCodeDataList containing mulitple ConsignmentModel.CODE

Returns:

the generated HTML template for the consolidated pick slip

packConsignment

public java.lang.String packConsignment(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

API to pack a ConsignmentModel and its pack label

Specified by:

packConsignment in interface WarehousingConsignmentFacade

Parameters:

code - the ConsignmentModel.CODE

Returns:

the generated HTML template for the pack label

packConsignment

public java.lang.String packConsignment(java.lang.String code,
                                        boolean printSlip)

Description copied from interface: WarehousingConsignmentFacade

API to pack a ConsignmentModel and optionally return its pack label

Specified by:

packConsignment in interface WarehousingConsignmentFacade

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

getExportForm

public java.lang.String getExportForm(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

API to get the export form of a ConsignmentModel

Specified by:

getExportForm in interface WarehousingConsignmentFacade

Parameters:

code - the ConsignmentModel.CODE

Returns:

the generated HTML template for the export form

getShippingLabel

public java.lang.String getShippingLabel(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

API to get the shipping label of a ConsignmentModel

Specified by:

getShippingLabel in interface WarehousingConsignmentFacade

Parameters:

code - the ConsignmentModel.CODE

Returns:

the generated HTML template for the shipping label

getReturnShippingLabel

public java.lang.String getReturnShippingLabel(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

API to get the return shipping label of a ConsignmentModel

Specified by:

getReturnShippingLabel in interface WarehousingConsignmentFacade

Parameters:

code - the ConsignmentModel.CODE

Returns:

the generated HTML template for the return shipping label

getReturnForm

public java.lang.String getReturnForm(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

API to get the return form of a ConsignmentModel

Specified by:

getReturnForm in interface WarehousingConsignmentFacade

Parameters:

code - the ConsignmentModel.CODE

Returns:

the generated HTML template for the return form

takePayment

public PaymentTransactionEntryData takePayment(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

API to take payment for a ConsignmentModel

Specified by:

takePayment in interface WarehousingConsignmentFacade

Parameters:

code - the ConsignmentModel.CODE

Returns:

the PaymentTransactionEntryData with the recorded transaction

manuallyReleasePaymentCapture

public void manuallyReleasePaymentCapture(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

API to manually release a ConsignmentModel after a payment capture failure

Specified by:

manuallyReleasePaymentCapture in interface WarehousingConsignmentFacade

Parameters:

code - the ConsignmentModel.CODE

manuallyReleaseTaxCommit

public void manuallyReleaseTaxCommit(java.lang.String code)

Description copied from interface: WarehousingConsignmentFacade

API to manually release a ConsignmentModel after a tax commit failure

Specified by:

manuallyReleaseTaxCommit in interface WarehousingConsignmentFacade

Parameters:

code - the ConsignmentModel.CODE

performPaymentCapture

protected PaymentTransactionEntryModel performPaymentCapture(ConsignmentModel consignmentModel)

Performs the payment capture operation for the given ConsignmentModel

Parameters:

consignmentModel - the ConsignmentModel whose amount is to be captured

Returns:

the PaymentTransactionEntryModel for the transaction

packConsignment

protected java.lang.String packConsignment(ConsignmentModel consignmentModel,
                                           boolean printSlip)

Performs common logic for packing a ConsignmentModel

Parameters:

consignmentModel - the ConsignmentModel to be packed

printSlip - whether or not the generate the pack slip

Returns:

the generated pack slip

Throws:

java.lang.IllegalStateException - throw an IllegalStateException if the ConsignmentModel has already been packed and if the slip should not be generated

getConsignmentModelForCode

protected ConsignmentModel getConsignmentModelForCode(java.lang.String code)

Finds ConsignmentModel for the given ConsignmentModel.CODE

Parameters:

code - the consignment's code

Returns:

the requested consignment for the given code

getSublistOfSourcingLocations

protected java.util.List<WarehouseModel> getSublistOfSourcingLocations(PageableData pageableData,
                                                                       java.util.List<WarehouseModel> locations)

Gets a sub list based on the pageable data object from the list containing all warehouses.

Parameters:

pageableData - the object which will filter the list with its page related information

locations - contains all available sourcing locations.

Returns:

the sub list which met the pageable data criteria

populateDeclineEntry

protected DeclineEntry populateDeclineEntry(DeclineEntryData declineEntryData,
                                            ConsignmentReallocationData consignmentReallocationData,
                                            ConsignmentEntryModel consignmentEntryModel)

Populates and returns DeclineEntry from given DeclineEntryData

Parameters:

declineEntryData - the given DeclineEntryData to prepare DeclineEntry

consignmentReallocationData - the ConsignmentReallocationData to check if ConsignmentReallocationData.globalComment, ConsignmentReallocationData.globalReallocationWarehouseCode and ConsignmentReallocationData.getGlobalReason() are present

consignmentEntryModel - the ConsignmentEntryModel

Returns:

the DeclineEntry populated from the given params

validateDeclineEntryDataToReallocate

protected void validateDeclineEntryDataToReallocate(ConsignmentReallocationData consignmentReallocationData,
                                                    DeclineEntryData declineEntryData,
                                                    ConsignmentEntryModel consignmentEntry)

Validation for DeclineEntryData to be reallocated against given ConsignmentEntryModel.

Parameters:

consignmentReallocationData - the ConsignmentReallocationData to be validated

declineEntryData - the DeclineEntryData to be validated

consignmentEntry - the ConsignmentEntryModel, against which given declineEntryData needs to be validated

buildDeclineParam

protected void buildDeclineParam(ConsignmentProcessModel processModel,
                                 java.util.List<DeclineEntry> entriesToReallocate)

Build and save the context parameter for decline entries and set it into the given process

Parameters:

processModel - the process model for which the context parameters has to be register

entriesToReallocate - the entries to be reallocated

cleanDeclineParam

protected void cleanDeclineParam(ConsignmentProcessModel processModel)

Removes the old decline entries from BusinessProcessModel.CONTEXTPARAMETERS(if any exists), before attempting to decline

Parameters:

processModel - the ConsignmentProcessModel for the consignment to be declined

performPickWorkflowAction

protected void performPickWorkflowAction(ConsignmentModel consignmentModel,
                                         boolean printSlip)

Performs the Pick WorkflowActionModel for the given ConsignmentModel if the action has not been performed yet. Throws an IllegalStateException if the slip should not be generated and if the consignment was already picked

Parameters:

consignmentModel - the ConsignmentModel for which the action will potentially be performed

Throws:

java.lang.IllegalStateException - throw an IllegalStateException in either of the following 2 cases: 1. If the ConsignmentModel has already been picked and if the slip should not be generated 2. If the WorkflowActionModel is null and if the slip should not be generated

performPickWorkflowAction

protected void performPickWorkflowAction(ConsignmentModel consignmentModel)

Performs the Pick WorkflowActionModel for the given ConsignmentModel if the action has not been performed yet.

Parameters:

consignmentModel - the ConsignmentModel for which the action will potentially be performed

generateBusinessProcess

protected BusinessProcessModel generateBusinessProcess(java.util.List<ConsignmentModel> consignmentModels)

Generates a dummy BusinessProcessModel with a List so that it can be passed to the PrintMediaService

Parameters:

consignmentModels - the List which will be passed to the new business process

Returns:

the dummy BusinessProcessModel

generateMediaTemplate

protected java.lang.String generateMediaTemplate(java.lang.String code,
                                                 java.lang.String template)

Generates a media template for the given ConsignmentModel.CODE and velocity template

Parameters:

code - the ConsignmentModel.CODE for which to generate a template

template - the template with which the media will be generated

Returns:

the newly generated media template

getEnumerationService

protected EnumerationService getEnumerationService()

setEnumerationService

public void setEnumerationService(EnumerationService enumerationService)

getConsignmentGenericDao

protected GenericDao<ConsignmentModel> getConsignmentGenericDao()

setConsignmentGenericDao

public void setConsignmentGenericDao(GenericDao<ConsignmentModel> consignmentGenericDao)

getConsignmentPagedGenericDao

protected PagedGenericDao<ConsignmentModel> getConsignmentPagedGenericDao()

setConsignmentPagedGenericDao

public void setConsignmentPagedGenericDao(PagedGenericDao<ConsignmentModel> consignmentPagedGenericDao)

getConsignmentConverter

protected Converter<ConsignmentModel,ConsignmentData> getConsignmentConverter()

setConsignmentConverter

public void setConsignmentConverter(Converter<ConsignmentModel,ConsignmentData> consignmentConverter)

getWarehouseConverter

protected Converter<WarehouseModel,WarehouseData> getWarehouseConverter()

setWarehouseConverter

public void setWarehouseConverter(Converter<WarehouseModel,WarehouseData> warehouseConverter)

getPackagingInfoConverter

protected Converter<PackagingInfoModel,PackagingInfoData> getPackagingInfoConverter()

setPackagingInfoConverter

public void setPackagingInfoConverter(Converter<PackagingInfoModel,PackagingInfoData> packagingInfoConverter)

getReversePackagingInfoConverter

protected Converter<PackagingInfoData,PackagingInfoModel> getReversePackagingInfoConverter()

setReversePackagingInfoConverter

public void setReversePackagingInfoConverter(Converter<PackagingInfoData,PackagingInfoModel> reversePackagingInfoConverter)

getConsignmentSearchByStatusPagedDao

protected SearchByStatusPagedGenericDao<ConsignmentModel> getConsignmentSearchByStatusPagedDao()

setConsignmentSearchByStatusPagedDao

public void setConsignmentSearchByStatusPagedDao(SearchByStatusPagedGenericDao<ConsignmentModel> consignmentSearchByStatusPagedDao)

getConsignmentEntryPagedDao

protected PagedGenericDao getConsignmentEntryPagedDao()

setConsignmentEntryPagedDao

public void setConsignmentEntryPagedDao(PagedGenericDao consignmentEntryPagedDao)

getConsignmentEntryConverter

protected Converter<ConsignmentEntryModel,ConsignmentEntryData> getConsignmentEntryConverter()

setConsignmentEntryConverter

public void setConsignmentEntryConverter(Converter<ConsignmentEntryModel,ConsignmentEntryData> consignmentEntryConverter)

getWarehousingShippingService

protected WarehousingShippingService getWarehousingShippingService()

setWarehousingShippingService

public void setWarehousingShippingService(WarehousingShippingService warehousingShippingService)

getSourcingFilterProcessor

protected SourcingFilterProcessor getSourcingFilterProcessor()

setSourcingFilterProcessor

public void setSourcingFilterProcessor(SourcingFilterProcessor sourcingFilterProcessor)

getWarehouseService

public WarehouseService getWarehouseService()

setWarehouseService

public void setWarehouseService(WarehouseService warehouseService)

getConsignmentBusinessProcessService

protected WarehousingBusinessProcessService<ConsignmentModel> getConsignmentBusinessProcessService()

setConsignmentBusinessProcessService

public void setConsignmentBusinessProcessService(WarehousingBusinessProcessService<ConsignmentModel> consignmentBusinessProcessService)

getWarehouseStockService

protected WarehouseStockService getWarehouseStockService()

setWarehouseStockService

public void setWarehouseStockService(WarehouseStockService warehouseStockService)

getReallocableConsignmentStatusList

protected java.util.List<ConsignmentStatus> getReallocableConsignmentStatusList()

setReallocableConsignmentStatusList

public void setReallocableConsignmentStatusList(java.util.List<ConsignmentStatus> reallocableConsignmentStatusList)

getPrintMediaService

protected PrintMediaService getPrintMediaService()

setPrintMediaService

public void setPrintMediaService(PrintMediaService printMediaService)

getWarehousingConsignmentWorkflowService

protected WarehousingConsignmentWorkflowService getWarehousingConsignmentWorkflowService()

setWarehousingConsignmentWorkflowService

public void setWarehousingConsignmentWorkflowService(WarehousingConsignmentWorkflowService warehousingConsignmentWorkflowService)

getPaymentTransactionEntryConverter

protected Converter<PaymentTransactionEntryModel,PaymentTransactionEntryData> getPaymentTransactionEntryConverter()

setPaymentTransactionEntryConverter

public void setPaymentTransactionEntryConverter(Converter<PaymentTransactionEntryModel,PaymentTransactionEntryData> paymentTransactionEntryConverter)

getConsignmentAmountCalculationStrategy

protected ConsignmentAmountCalculationStrategy getConsignmentAmountCalculationStrategy()

setConsignmentAmountCalculationStrategy

public void setConsignmentAmountCalculationStrategy(ConsignmentAmountCalculationStrategy consignmentAmountCalculationStrategy)

getPaymentService

protected PaymentService getPaymentService()

setPaymentService

public void setPaymentService(PaymentService paymentService)

getConfigurationService

protected ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)