de.hybris.platform.warehousingwebservices.controllers.order

Class WarehousingConsignmentsController

java.lang.Object

de.hybris.platform.warehousingwebservices.controllers.WarehousingBaseController

de.hybris.platform.warehousingwebservices.controllers.order.WarehousingConsignmentsController

public class WarehousingConsignmentsController
extends WarehousingBaseController

WebResource exposing WarehousingConsignmentFacade http://host:port/warehousingwebservices/consignments

Field Summary

Fields inherited from class de.hybris.platform.warehousingwebservices.controllers.WarehousingBaseController

dataMapper, DEFAULT_CURRENT_PAGE, DEFAULT_FIELD_SET, DEFAULT_PAGE_SIZE, DEFAULT_SORT

Constructor Summary

Constructors

Constructor and Description
WarehousingConsignmentsController()

Method Summary

Modifier and Type	Method and Description
void	confirmPickupConsignment(java.lang.String code) Request to confirm ConsignmentModel's pickup
void	confirmShipConsignment(java.lang.String code) Request to confirm ConsignmentModel's shipping
java.lang.String	consolidatedPickConsignments(ConsignmentCodesWsDTO consignmentCodes) Request to pick, if applicable, each ConsignmentModel for the provided list of consignment codes and generate a consolidated pick slip.
protected java.util.Set<ConsignmentStatus>	extractConsignmentStatuses(java.lang.String statuses) Extract the set of ConsignmentStatus from the request
ConsignmentEntrySearchPageWsDto	getConsignmentEntriesForConsignmentCode(java.lang.String code, java.lang.String fields, int currentPage, int pageSize, java.lang.String sort) Request to get all ConsignmentEntryModel for the given "code"
ConsignmentWsDTO	getConsignmentForCode(java.lang.String code, java.lang.String fields) Request to get ConsignmentModel for the given code
protected Validator	getConsignmentReallocationValidator()
ConsignmentSearchPageWsDto	getConsignments(java.lang.String fields, int currentPage, int pageSize, java.lang.String sort) Request to get all ConsignmentModel in the system
ConsignmentSearchPageWsDto	getConsignmentsByStatus(java.lang.String consignmentStatuses, java.lang.String fields, int currentPage, int pageSize, java.lang.String sort) Request to get all ConsignmentModel with certain consignment status(es)
ConsignmentStatusListWsDTO	getConsignmentStatuses() Request to get all ConsignmentStatus in the system
DeclineReasonListWsDTO	getDeclineReasons() Request to get all DeclineReason available in the system.
java.lang.String	getExportForm(java.lang.String code) Request to get the export form of a ConsignmentModel
PackagingInfoWsDTO	getPackagingInfo(java.lang.String code) Request to get PackagingInfoWsDTO for the given ConsignmentModel.CODE
protected Validator	getPackagingInfoDTOValidator()
java.lang.String	getReturnForm(java.lang.String code) Request to get the return form of a ConsignmentModel
java.lang.String	getReturnShippingLabel(java.lang.String code) Request to get the return shipping label of a Consignment
java.lang.String	getShippingLabel(java.lang.String code) Request to get the shipping label of a ConsignmentModel
WarehouseSearchPageWsDto	getSourcingLocationsForConsignmentCode(java.lang.String code, java.lang.String fields, int currentPage, int pageSize, java.lang.String sort) Request to get all sourcing locations for the given "code"
java.lang.Boolean	isConsignmentConfirmable(java.lang.String code) Request to check if ConsignmentModel can be confirmed
void	manuallyReleasePaymentCapture(java.lang.String code) Request to manually release ConsignmentModel from the waiting step after the payment capture has failed
void	manuallyReleaseTaxCommit(java.lang.String code) Request to manully release ConsignmentModel from the waiting step after a tax commit failure
java.lang.String	packConsignment(java.lang.String code, boolean printSlip) Request to pack a ConsignmentModel and optionally generate its Pack Label
java.lang.String	pickConsignment(java.lang.String code, boolean printSlip) Request to pick a ConsignmentModel and generate its Pick Slip
void	reallocateConsignment(ConsignmentReallocationWsDTO consignmentReallocationWsDTO, java.lang.String code) Request to reallocate a ConsignmentModel to a new warehouse.
void	setConsignmentReallocationDTOValidator(Validator consignmentReallocationValidator)
void	setPackagingInfoDTOValidator(Validator packagingInfoDTOValidator)
PaymentTransactionEntryWsDTO	takePayment(java.lang.String code, java.lang.String fields) Request to take a payment for a ConsignmentModel
ConsignmentWsDTO	updatePackagingInfo(PackagingInfoWsDTO packagingInfo, java.lang.String code, java.lang.String fields) Request to update a ConsignmentModel with a new Packaging information.

Methods inherited from class de.hybris.platform.warehousingwebservices.controllers.WarehousingBaseController

createPageable, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

WarehousingConsignmentsController

public WarehousingConsignmentsController()

Method Detail

getConsignments

public ConsignmentSearchPageWsDto getConsignments(java.lang.String fields,
                                                  int currentPage,
                                                  int pageSize,
                                                  java.lang.String sort)

Request to get all ConsignmentModel in the system

Parameters:

fields - defaulted to DEFAULT but can be FULL or BASIC

currentPage - number of the current page

pageSize - number of items in a page

sort - sorting the results ascending or descending

Returns:

list of ConsignmentModel

getConsignmentForCode

public ConsignmentWsDTO getConsignmentForCode(java.lang.String code,
                                              java.lang.String fields)

Request to get ConsignmentModel for the given code

Parameters:

fields - defaulted to DEFAULT but can be FULL or BASIC

code - code to get the required consignment

Returns:

ConsignmentModel details for the given code

getSourcingLocationsForConsignmentCode

public WarehouseSearchPageWsDto getSourcingLocationsForConsignmentCode(java.lang.String code,
                                                                       java.lang.String fields,
                                                                       int currentPage,
                                                                       int pageSize,
                                                                       java.lang.String sort)

Request to get all sourcing locations for the given "code"

Parameters:

code - ConsignmentModel.CODE for the requested sourcing location

fields - defaulted to DEFAULT but can be FULL or BASIC

currentPage - number of the current page

pageSize - number of items in a page

sort - sorting the results ascending or descending

Returns:

list of locations compliant to the above conditions

getConsignmentsByStatus

public ConsignmentSearchPageWsDto getConsignmentsByStatus(java.lang.String consignmentStatuses,
                                                          java.lang.String fields,
                                                          int currentPage,
                                                          int pageSize,
                                                          java.lang.String sort)
                                                   throws WebserviceValidationException

Request to get all ConsignmentModel with certain consignment status(es)

Parameters:

consignmentStatuses - a list of valid ConsignmentStatus separated by ","

fields - defaulted to DEFAULT but can be FULL or BASIC

currentPage - number of the current page

pageSize - number of items in a page

sort - sorting the results ascending or descending

Returns:

list of ConsignmentModel that complies with conditions above

Throws:

WebserviceValidationException - in case of passing a wrong ConsignmentStatus

getConsignmentStatuses

public ConsignmentStatusListWsDTO getConsignmentStatuses()

Request to get all ConsignmentStatus in the system

Returns:

list of ConsignmentStatus

getDeclineReasons

public DeclineReasonListWsDTO getDeclineReasons()

Request to get all DeclineReason available in the system.

Returns:

list of DeclineReason

getConsignmentEntriesForConsignmentCode

public ConsignmentEntrySearchPageWsDto getConsignmentEntriesForConsignmentCode(java.lang.String code,
                                                                               java.lang.String fields,
                                                                               int currentPage,
                                                                               int pageSize,
                                                                               java.lang.String sort)

Request to get all ConsignmentEntryModel for the given "code"

Parameters:

code - for the requested consignment entries

fields - defaulted to DEFAULT but can be FULL or BASIC

currentPage - number of the current page

pageSize - number of items in a page

sort - sorting the results ascending or descending

Returns:

list of ConsignmentEntryModel fulfilling the above conditions

confirmShipConsignment

public void confirmShipConsignment(java.lang.String code)

Request to confirm ConsignmentModel's shipping

Parameters:

code - consignment's code for the requested consignment

confirmPickupConsignment

public void confirmPickupConsignment(java.lang.String code)

Request to confirm ConsignmentModel's pickup

Parameters:

code - ConsignmentModel.CODE for the requested consignment

isConsignmentConfirmable

public java.lang.Boolean isConsignmentConfirmable(java.lang.String code)

Request to check if ConsignmentModel can be confirmed

Parameters:

code - ConsignmentModel.CODE for the requested consignment

getPackagingInfo

public PackagingInfoWsDTO getPackagingInfo(java.lang.String code)

Request to get PackagingInfoWsDTO for the given ConsignmentModel.CODE

Parameters:

code - code of the consignment for which to get the packaging information

Returns:

the packaging information of the ConsignmentModel

updatePackagingInfo

public ConsignmentWsDTO updatePackagingInfo(PackagingInfoWsDTO packagingInfo,
                                            java.lang.String code,
                                            java.lang.String fields)

Request to update a ConsignmentModel with a new Packaging information.

Parameters:

packagingInfo - the PackagingInfoWsDTO to update the consignment with

code - ConsignmentModel.CODE for which to update the packaging information

fields - defaulted to DEFAULT but can be FULL or BASIC

Returns:

updated ConsignmentWsDTO

reallocateConsignment

public void reallocateConsignment(ConsignmentReallocationWsDTO consignmentReallocationWsDTO,
                                  java.lang.String code)

Request to reallocate a ConsignmentModel to a new warehouse.

Parameters:

consignmentReallocationWsDTO - the dto containing entries to be reallocated

code - ConsignmentModel.CODE to be reallocated

pickConsignment

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

Request to pick a ConsignmentModel and generate its Pick Slip

Parameters:

code - ConsignmentModel.CODE for the requested consignment

printSlip - Flag for backwards compatibility. Used to check if the pick slip will be generated

Returns:

the optionally generated html Pick Slip template

consolidatedPickConsignments

public java.lang.String consolidatedPickConsignments(ConsignmentCodesWsDTO consignmentCodes)

Request to pick, if applicable, each ConsignmentModel for the provided list of consignment codes and generate a consolidated pick slip.

Parameters:

consignmentCodes - a list of consignment codes

Returns:

the generated html Consolidated Pick Slip template

packConsignment

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

Request to pack a ConsignmentModel and optionally generate its Pack Label

Parameters:

code - ConsignmentModel.CODE for the request consignment

printSlip - Flag for backwards compatibility. Used to check if the pack label will be generated

Returns:

the optionally generated html Pack Label template

getExportForm

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

Request to get the export form of a ConsignmentModel

Parameters:

code - ConsignmentModel.CODE for the request consignment

Returns:

the generated html Export Form template

getShippingLabel

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

Request to get the shipping label of a ConsignmentModel

Parameters:

code - ConsignmentModel.CODE for the request consignment

Returns:

the generated html Shipping Label template

getReturnShippingLabel

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

Request to get the return shipping label of a Consignment

Parameters:

code - consignment's code for the request consignment

Returns:

the generated html Return Shipping Label template

getReturnForm

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

Request to get the return form of a ConsignmentModel

Parameters:

code - ConsignmentModel.CODE for the request consignment

Returns:

the generated html Return Form template

takePayment

public PaymentTransactionEntryWsDTO takePayment(java.lang.String code,
                                                java.lang.String fields)

Request to take a payment for a ConsignmentModel

Parameters:

code - ConsignmentModel.CODE for the request consignment

Returns:

the PaymentTransactionEntryWsDTO

manuallyReleasePaymentCapture

public void manuallyReleasePaymentCapture(java.lang.String code)

Request to manually release ConsignmentModel from the waiting step after the payment capture has failed

Parameters:

code - ConsignmentModel.CODE for the request consignment

manuallyReleaseTaxCommit

public void manuallyReleaseTaxCommit(java.lang.String code)

Request to manully release ConsignmentModel from the waiting step after a tax commit failure

Parameters:

code - ConsignmentModel.CODE for the requested consignment

extractConsignmentStatuses

protected java.util.Set<ConsignmentStatus> extractConsignmentStatuses(java.lang.String statuses)

Extract the set of ConsignmentStatus from the request

Parameters:

statuses - "," separated ConsignmentStatus

Returns:

set of ConsignmentStatus

Throws:

WebserviceValidationException - in case of passing a wrong ConsignmentStatus

getPackagingInfoDTOValidator

protected Validator getPackagingInfoDTOValidator()

setPackagingInfoDTOValidator

public void setPackagingInfoDTOValidator(Validator packagingInfoDTOValidator)

getConsignmentReallocationValidator

protected Validator getConsignmentReallocationValidator()

setConsignmentReallocationDTOValidator

public void setConsignmentReallocationDTOValidator(Validator consignmentReallocationValidator)