Package de.aeb.xnsg.dl.bf

Interface IDLCarrierBF

@BusinessFacade(extraPackages={"de.aeb.xnsg.foundation.bf","de.aeb.xnsg.logistics.bf"})
public interface IDLCarrierBF

Business facade for the CarrierEngine

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RECORD_TYPE_ADD_SHIPMENT_ATTACHMENTS
static final String	RECORD_TYPE_CANCEL_SHIPMENT
static final String	RECORD_TYPE_CREATE_PICKUP
static final String	RECORD_TYPE_CREATE_SHIPMENT
static final String	RECORD_TYPE_DELETE_PACKAGE
static final String	RECORD_TYPE_DELETE_PICKUP
static final String	RECORD_TYPE_GET_ALLCARRIERS
static final String	RECORD_TYPE_GET_CARRIERPORTFOLIO_DETAILS
static final String	RECORD_TYPE_GET_CARRIERPORTFOLIO_NAMES
static final String	RECORD_TYPE_GET_CARRIERPROPERTIES
static final String	RECORD_TYPE_GET_PICKUPS
static final String	RECORD_TYPE_GET_SHIPMENTS
static final String	RECORD_TYPE_PROCESS_PACKAGE
static final String	RECORD_TYPE_PROCESS_PICKUP
static final String	RECORD_TYPE_PROCESS_SHIPMENT
static final String	RECORD_TYPE_SYNC_PICKUP
static final String	RECORD_TYPE_SYNC_SHIPMENT
static final String	RECORD_TYPE_UDPATE_CUSTOMS_DATA
static final String	RECORD_TYPE_VALIDATE_SHIPMENT

Method Summary

Modifier and Type	Method	Description
DLAddShipmentAttachmentsResponseDTO	addShipmentAttachments(DLAddShipmentAttachmentsRequestDTO request)	Adds attachments to a shipment (e.g. invoices, origin documents, etc.).
DLCancelShipmentResponseDTO	cancelShipment(DLCancelShipmentRequestDTO request)	Cancels a shipment.
DLCreatePickupResponseDTO	createPickup(DLCreatePickupRequestDTO request)	Creates a new pickup for the shipments specified in the request. Depending on the request, an error may be returned when the shipments can't form a single pickup, e.g. when they have different carriers. Optionally the new pickup can be manifested.
DLCreateShipmentResponseDTO	createShipment(DLCreateShipmentRequestDTO request)	Creates a shipment with the data specified in the shipment request. An error will be returned when the shipment exists already. Optionally various operations like label preparation and label output can be applied on the shipment.
DLDeleteItemResponseDTO	deleteItem(DLDeleteItemRequestDTO request)	Deletes an existing item.
DLDeletePackageResponseDTO	deletePackage(DLDeletePackageRequestDTO request)	Deletes an existing package.
DLDeletePickupResponseDTO	deletePickup(DLDeletePickupRequestDTO request)	Cancels an existing pickup.
DLGetAllCarriersResponseDTO	getAllCarriers(DLGetAllCarriersRequestDTO request)	Returns a list of all carrier available for the requested client.
DLGetCarrierPortfolioDetailsResponseDTO	getCarrierPortfolioDetails(DLGetCarrierPortfolioDetailsRequestDTO request)	Returns detailed information about the requested carriers.
DLGetCarrierPortfolioNamesResponseDTO	getCarrierPortfolioNames(DLGetCarrierPortfolioNamesRequestDTO request)	Returns a list of the names of all supported carriers.
DLGetCarrierPropertiesResponseDTO	getCarrierProperties(DLGetCarrierPropertiesRequestDTO request)	Returns the properties of the requested carrier.
DLGetPickupsResponseDTO	getPickups(DLGetPickupsRequestDTO request)	Returns detail information about specific pickups.
DLGetShipmentsResponseDTO	getShipments(DLGetShipmentsRequestDTO request)	Returns detail information about specific shipments.
DLProcessPackageResponseDTO	processPackage(DLProcessPackageRequestDTO request)	Allows to perform various operations on an existing package.
DLProcessPickupResponseDTO	processPickup(DLProcessPickupRequestDTO request)	Prints or reprints the manifest documents for the pickup.
DLProcessShipmentResponseDTO	processShipment(DLProcessShipmentRequestDTO request)	Allows to add packages or perform various operations on an existing shipment.
DLSyncPickupsResponseDTO	syncPickups(DLSyncPickupsRequestDTO request)	Allows the synchronization of client system transactions with the engine pickups.
DLSyncShipmentsResponseDTO	syncShipments(DLSyncShipmentsRequestDTO request)	Allows the synchronization of client system transactions with the engine shipments.
DLUpdateCustomsDataResponseDTO	updateCustomsData(DLUpdateCustomsDataRequestDTO request)	Updates customs data for one existing shipment.
DLValidateShipmentResponseDTO	validateShipment(DLValidateShipmentRequestDTO request)	Validates a shipment with the data specified in the shipment request. Various validation operations can be applied on the shipment to determine, whether the shipment can be processed.

Field Details

RECORD_TYPE_CREATE_SHIPMENT

static final String RECORD_TYPE_CREATE_SHIPMENT

See Also:

• Constant Field Values

RECORD_TYPE_PROCESS_SHIPMENT

static final String RECORD_TYPE_PROCESS_SHIPMENT

See Also:

• Constant Field Values

RECORD_TYPE_CANCEL_SHIPMENT

static final String RECORD_TYPE_CANCEL_SHIPMENT

See Also:

• Constant Field Values

RECORD_TYPE_PROCESS_PACKAGE

static final String RECORD_TYPE_PROCESS_PACKAGE

See Also:

• Constant Field Values

RECORD_TYPE_GET_SHIPMENTS

static final String RECORD_TYPE_GET_SHIPMENTS

See Also:

• Constant Field Values

RECORD_TYPE_SYNC_SHIPMENT

static final String RECORD_TYPE_SYNC_SHIPMENT

See Also:

• Constant Field Values

RECORD_TYPE_CREATE_PICKUP

static final String RECORD_TYPE_CREATE_PICKUP

See Also:

• Constant Field Values

RECORD_TYPE_DELETE_PICKUP

static final String RECORD_TYPE_DELETE_PICKUP

See Also:

• Constant Field Values

RECORD_TYPE_PROCESS_PICKUP

static final String RECORD_TYPE_PROCESS_PICKUP

See Also:

• Constant Field Values

RECORD_TYPE_GET_PICKUPS

static final String RECORD_TYPE_GET_PICKUPS

See Also:

• Constant Field Values

RECORD_TYPE_SYNC_PICKUP

static final String RECORD_TYPE_SYNC_PICKUP

See Also:

• Constant Field Values

RECORD_TYPE_GET_ALLCARRIERS

static final String RECORD_TYPE_GET_ALLCARRIERS

See Also:

• Constant Field Values

RECORD_TYPE_GET_CARRIERPROPERTIES

static final String RECORD_TYPE_GET_CARRIERPROPERTIES

See Also:

• Constant Field Values

RECORD_TYPE_VALIDATE_SHIPMENT

static final String RECORD_TYPE_VALIDATE_SHIPMENT

See Also:

• Constant Field Values

RECORD_TYPE_DELETE_PACKAGE

static final String RECORD_TYPE_DELETE_PACKAGE

See Also:

• Constant Field Values

RECORD_TYPE_GET_CARRIERPORTFOLIO_NAMES

static final String RECORD_TYPE_GET_CARRIERPORTFOLIO_NAMES

See Also:

• Constant Field Values

RECORD_TYPE_GET_CARRIERPORTFOLIO_DETAILS

static final String RECORD_TYPE_GET_CARRIERPORTFOLIO_DETAILS

See Also:

• Constant Field Values

RECORD_TYPE_ADD_SHIPMENT_ATTACHMENTS

static final String RECORD_TYPE_ADD_SHIPMENT_ATTACHMENTS

See Also:

• Constant Field Values

RECORD_TYPE_UDPATE_CUSTOMS_DATA

static final String RECORD_TYPE_UDPATE_CUSTOMS_DATA

See Also:

• Constant Field Values

Method Details

createShipment

DLCreateShipmentResponseDTO createShipment(DLCreateShipmentRequestDTO request)

Creates a shipment with the data specified in the shipment request.
An error will be returned when the shipment exists already.
Optionally various operations like label preparation and label output can be applied on the shipment. A complete processing including the pickup assignment is also possible.
The operations are handled asynchronously, so operation processing errors and label documents are not part of the response. They can be retrieved with a syncShipments or getShipments call.

Parameters:

request -

Returns:

Throws:

RemoteException

processShipment

DLProcessShipmentResponseDTO processShipment(DLProcessShipmentRequestDTO request)

Allows to add packages or perform various operations on an existing shipment. Especially document preparation and document (label) output can be triggered.
When the request is specified to handle the operations asynchronously, operation processing errors and label documents are not part of the response. They can be retrieved with a syncShipments or getShipments call.

Parameters:

request -

Returns:

Throws:

RemoteException

cancelShipment

DLCancelShipmentResponseDTO cancelShipment(DLCancelShipmentRequestDTO request)

Cancels a shipment.

Parameters:

request -

Returns:

Throws:

RemoteException

updateCustomsData

DLUpdateCustomsDataResponseDTO updateCustomsData(DLUpdateCustomsDataRequestDTO request)

Updates customs data for one existing shipment. Updates data on shipment and item level. Updates customs relevant data only.

Parameters:

request -

Returns:

processPackage

DLProcessPackageResponseDTO processPackage(DLProcessPackageRequestDTO request)

Allows to perform various operations on an existing package. Especially document preparation and document (label) output can be triggered.
When the request is specified to handle the operations asynchronously, operation processing errors and label documents are not part of the response. They can be retrieved with a further processPackage call, a syncShipments or getShipments call.

Parameters:

request -

Returns:

Throws:

RemoteException

getShipments

DLGetShipmentsResponseDTO getShipments(DLGetShipmentsRequestDTO request)

Returns detail information about specific shipments.

Parameters:

request -

Returns:

Throws:

RemoteException

syncShipments

DLSyncShipmentsResponseDTO syncShipments(DLSyncShipmentsRequestDTO request)

Allows the synchronization of client system transactions with the engine shipments. By the use of a syncId it is possible to return only shipments that have changed between two syncShipments calls.

Parameters:

request -

Returns:

Throws:

RemoteException

createPickup

DLCreatePickupResponseDTO createPickup(DLCreatePickupRequestDTO request)

Creates a new pickup for the shipments specified in the request.
Depending on the request, an error may be returned when the shipments can't form a single pickup, e.g. when they have different carriers.
Optionally the new pickup can be manifested. That means that the EDI is sent to the carrier if necessary and the pickup will be closed.
When specified in request, the manifest documents are printed.

Parameters:

request -

Returns:

Throws:

RemoteException

deletePickup

DLDeletePickupResponseDTO deletePickup(DLDeletePickupRequestDTO request)

Cancels an existing pickup. All shipments are removed from the pickup and must be assigned to a new pickup by another createPickup call.
Warning: EDI data for the existing pickup might have already been sent to the carrier. So check with the carrier that it's fine to cancel the pickup and create a new (differing) one.

Parameters:

request -

Returns:

processPickup

DLProcessPickupResponseDTO processPickup(DLProcessPickupRequestDTO request)

Prints or reprints the manifest documents for the pickup. Mainly to be used, when manifest documents were not printed with the createPickup call or if a reprint of the documents is necessary.

Parameters:

request -

Returns:

Throws:

RemoteException

getPickups

DLGetPickupsResponseDTO getPickups(DLGetPickupsRequestDTO request)

Returns detail information about specific pickups.

Parameters:

request -

Returns:

Throws:

RemoteException

syncPickups

DLSyncPickupsResponseDTO syncPickups(DLSyncPickupsRequestDTO request)

Allows the synchronization of client system transactions with the engine pickups. By the use of a syncId it is possible to return only pickups that have changed between two syncPickups calls.

Parameters:

request -

Returns:

Throws:

RemoteException

getAllCarriers

DLGetAllCarriersResponseDTO getAllCarriers(DLGetAllCarriersRequestDTO request)

Returns a list of all carrier available for the requested client.

Parameters:

request -

Returns:

Throws:

RemoteException

getCarrierProperties

DLGetCarrierPropertiesResponseDTO getCarrierProperties(DLGetCarrierPropertiesRequestDTO request)

Returns the properties of the requested carrier.

Parameters:

request -

Returns:

Throws:

RemoteException

validateShipment

DLValidateShipmentResponseDTO validateShipment(DLValidateShipmentRequestDTO request)

Validates a shipment with the data specified in the shipment request.
Various validation operations can be applied on the shipment to determine, whether the shipment can be processed.

Parameters:

request -

Returns:

deletePackage

DLDeletePackageResponseDTO deletePackage(DLDeletePackageRequestDTO request)

Deletes an existing package. Packed items remain unpacked in the shipment and can be packaged again with processShipment. Deleting a package is not always possible. It mainly depends on the status of the package and the shipment.

Parameters:

request -

Returns:

deleteItem

DLDeleteItemResponseDTO deleteItem(DLDeleteItemRequestDTO request)

Deletes an existing item. Packages containing items remain in the shipment and can be packed again with processShipment. Deleting a item is not always possible. It mainly depends on the status of the package containing the item and the shipment.

Parameters:

request -

Returns:

getCarrierPortfolioDetails

DLGetCarrierPortfolioDetailsResponseDTO getCarrierPortfolioDetails(DLGetCarrierPortfolioDetailsRequestDTO request)

Returns detailed information about the requested carriers.

Parameters:

request -

Returns:

Throws:

RemoteException

getCarrierPortfolioNames

DLGetCarrierPortfolioNamesResponseDTO getCarrierPortfolioNames(DLGetCarrierPortfolioNamesRequestDTO request)

Returns a list of the names of all supported carriers.

Parameters:

request -

Returns:

Throws:

RemoteException

addShipmentAttachments

DLAddShipmentAttachmentsResponseDTO addShipmentAttachments(DLAddShipmentAttachmentsRequestDTO request)

Adds attachments to a shipment (e.g. invoices, origin documents, etc.).

Parameters:

request -

Returns:

Throws:

RemoteException