de.hybris.platform.consignmenttrackingservices.service.impl

Class DefaultConsignmentTrackingService

java.lang.Object

de.hybris.platform.consignmenttrackingservices.service.impl.DefaultConsignmentTrackingService

All Implemented Interfaces:

ConsignmentTrackingService

public class DefaultConsignmentTrackingService
extends java.lang.Object
implements ConsignmentTrackingService

A default implementation of ConsignmentTrackingService.

Constructor Summary

Constructors

Constructor and Description
DefaultConsignmentTrackingService()

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,CarrierAdaptor>	getAllCarrierAdaptors() Get all carrier adaptors.
protected BaseSiteService	getBaseSiteService()
protected java.util.Optional<CarrierAdaptor>	getCarrierAdaptor(ConsignmentModel consignment)
protected java.util.Map<java.lang.String,CarrierAdaptor>	getCarrierAdaptors()
protected ConfigurationService	getConfigurationService()
protected ConsignmentDao	getConsignmentDao()
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
protected int	getDefaultDeliveryLeadTime() get default delivery lead time from properties
protected java.net.URL	getDefaultTrackingUrl() get default tracking URL from properties
int	getDeliveryLeadTime(ConsignmentModel consignment) provide the lead time of estimation from shipped to arrival
protected ModelService	getModelService()
protected SiteBaseUrlResolutionService	getSiteBaseUrlResolutionService()
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	setBaseSiteService(BaseSiteService baseSiteService)
void	setCarrierAdaptors(java.util.Map<java.lang.String,CarrierAdaptor> carrierAdaptors)
void	setConfigurationService(ConfigurationService configurationService)
void	setConsignmentDao(ConsignmentDao consignmentDao)
void	setModelService(ModelService modelService)
void	setSiteBaseUrlResolutionService(SiteBaseUrlResolutionService siteBaseUrlResolutionService)
void	updateConsignmentStatusForCode(java.lang.String orderCode, java.lang.String consignmentCode, ConsignmentStatus status) update consignment status and set arrival date if complete

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultConsignmentTrackingService

public DefaultConsignmentTrackingService()

Method Detail

getTrackingUrlForConsignment

public java.net.URL getTrackingUrlForConsignment(ConsignmentModel consignment)

Description copied from interface: ConsignmentTrackingService

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

Specified by:

getTrackingUrlForConsignment in interface ConsignmentTrackingService

Parameters:

consignment - the specific consignment

Returns:

tracking URL

isTrackingIdValid

public boolean isTrackingIdValid(ConsignmentModel consignment)

Description copied from interface: ConsignmentTrackingService

check if the tracking ID is valid in a carrier provider

Specified by:

isTrackingIdValid in interface ConsignmentTrackingService

Parameters:

consignment - the specific consignment

Returns:

true if valid, otherwise false

getConsignmentEvents

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

Description copied from interface: ConsignmentTrackingService

used by controller to handle incremental routes from carrier

Specified by:

getConsignmentEvents in interface ConsignmentTrackingService

Parameters:

consignment - the specific consignment

Returns:

latest consignment events

getConsignmentForCode

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

Description copied from interface: ConsignmentTrackingService

Query a ConsignmentModel for code.

Specified by:

getConsignmentForCode in interface ConsignmentTrackingService

Parameters:

orderCode - the code of this consignment's order

consignmentCode - code of consignment

Returns:

a instance of ConsignmentModel

getConsignmentsForOrder

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

Description copied from interface: ConsignmentTrackingService

Get all consignments under the order

Specified by:

getConsignmentsForOrder in interface ConsignmentTrackingService

Parameters:

orderCode - the order code

Returns:

all consignment for the order

updateConsignmentStatusForCode

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

Description copied from interface: ConsignmentTrackingService

update consignment status and set arrival date if complete

Specified by:

updateConsignmentStatusForCode in interface ConsignmentTrackingService

Parameters:

orderCode - the code of this consignment's order

consignmentCode - the specific consignmentCode

status - the new status from carrier

getDeliveryLeadTime

public int getDeliveryLeadTime(ConsignmentModel consignment)

Description copied from interface: ConsignmentTrackingService

provide the lead time of estimation from shipped to arrival

Specified by:

getDeliveryLeadTime in interface ConsignmentTrackingService

Parameters:

consignment - the specific consignment

Returns:

days of the lead time

getAllCarrierAdaptors

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

Description copied from interface: ConsignmentTrackingService

Get all carrier adaptors.

Specified by:

getAllCarrierAdaptors in interface ConsignmentTrackingService

Returns:

map of adaptors.

getCarrierAdaptor

protected java.util.Optional<CarrierAdaptor> getCarrierAdaptor(ConsignmentModel consignment)

getDefaultTrackingUrl

protected java.net.URL getDefaultTrackingUrl()

get default tracking URL from properties

Returns:

default tracking URL

getDefaultDeliveryLeadTime

protected int getDefaultDeliveryLeadTime()

get default delivery lead time from properties

Returns:

default delivery lead time

getConfigurationService

protected ConfigurationService getConfigurationService()

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

getCarrierAdaptors

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

setCarrierAdaptors

public void setCarrierAdaptors(java.util.Map<java.lang.String,CarrierAdaptor> carrierAdaptors)

getConsignmentDao

protected ConsignmentDao getConsignmentDao()

setConsignmentDao

public void setConsignmentDao(ConsignmentDao consignmentDao)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getSiteBaseUrlResolutionService

protected SiteBaseUrlResolutionService getSiteBaseUrlResolutionService()

setSiteBaseUrlResolutionService

public void setSiteBaseUrlResolutionService(SiteBaseUrlResolutionService siteBaseUrlResolutionService)

getBaseSiteService

protected BaseSiteService getBaseSiteService()

setBaseSiteService

public void setBaseSiteService(BaseSiteService baseSiteService)