de.hybris.platform.consignmenttrackingservices.service

Interface ConsignmentTrackingService

All Known Implementing Classes:

DefaultConsignmentTrackingService

public interface ConsignmentTrackingService

Service that provide consignment tracking related methods.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,CarrierAdaptor>	getAllCarrierAdaptors() Get all carrier adaptors.
java.util.List<ConsignmentEventData>	getConsignmentEvents(ConsignmentModel consignment) used by controller to handle incremental routes from carrier
java.util.Optional<ConsignmentModel>	getConsignmentForCode(java.lang.String orderCode, java.lang.String consignmentCode) Query a ConsignmentModel for code.
java.util.List<ConsignmentModel>	getConsignmentsForOrder(java.lang.String orderCode) Get all consignments under the order
int	getDeliveryLeadTime(ConsignmentModel consignment) provide the lead time of estimation from shipped to arrival
java.net.URL	getTrackingUrlForConsignment(ConsignmentModel consignment) tracking URL is given for display in frontend, if user wants to track package by jumping to carrier's website
boolean	isTrackingIdValid(ConsignmentModel consignment) check if the tracking ID is valid in a carrier provider
void	updateConsignmentStatusForCode(java.lang.String orderCode, java.lang.String consignmentCode, ConsignmentStatus status) update consignment status and set arrival date if complete

Method Detail

getTrackingUrlForConsignment

java.net.URL getTrackingUrlForConsignment(ConsignmentModel consignment)

tracking URL is given for display in frontend, if user wants to track package by jumping to carrier's website

Parameters:

consignment - the specific consignment

Returns:

tracking URL

isTrackingIdValid

boolean isTrackingIdValid(ConsignmentModel consignment)

check if the tracking ID is valid in a carrier provider

Parameters:

consignment - the specific consignment

Returns:

true if valid, otherwise false

getConsignmentEvents

java.util.List<ConsignmentEventData> getConsignmentEvents(ConsignmentModel consignment)

used by controller to handle incremental routes from carrier

Parameters:

consignment - the specific consignment

Returns:

latest consignment events

getConsignmentForCode

java.util.Optional<ConsignmentModel> getConsignmentForCode(java.lang.String orderCode,
                                                           java.lang.String consignmentCode)

Query a ConsignmentModel for code.

Parameters:

orderCode - the code of this consignment's order

consignmentCode - code of consignment

Returns:

a instance of ConsignmentModel

updateConsignmentStatusForCode

void updateConsignmentStatusForCode(java.lang.String orderCode,
                                    java.lang.String consignmentCode,
                                    ConsignmentStatus status)

update consignment status and set arrival date if complete

Parameters:

orderCode - the code of this consignment's order

consignmentCode - the specific consignmentCode

status - the new status from carrier

getDeliveryLeadTime

int getDeliveryLeadTime(ConsignmentModel consignment)

provide the lead time of estimation from shipped to arrival

Parameters:

consignment - the specific consignment

Returns:

days of the lead time

getAllCarrierAdaptors

java.util.Map<java.lang.String,CarrierAdaptor> getAllCarrierAdaptors()

Get all carrier adaptors.

Returns:

map of adaptors.

getConsignmentsForOrder

java.util.List<ConsignmentModel> getConsignmentsForOrder(java.lang.String orderCode)

Get all consignments under the order

Parameters:

orderCode - the order code

Returns:

all consignment for the order