Package de.aeb.xnsg.dl.bf

Class DLGetShipmentsRequestDTO

java.lang.Object

de.aeb.xnsg.foundation.bf.AbstractRequestDTO

de.aeb.xnsg.dl.bf.DLGetShipmentsRequestDTO

public class DLGetShipmentsRequestDTO
extends de.aeb.xnsg.foundation.bf.AbstractRequestDTO

DTO to search for shipments and request detail information about them.

Field Summary

Fields

Modifier and Type	Field	Description
DLShipmentFilterDTO	filter	Controls, which shipments should be returned.
Boolean	includeDocuments	Controls, if the (label) documents should be included in the response of each shipment.
static int	MAX_SHIPMENTS	Maximum number of shipments that can be requested.
DLShipmentReferenceDTO[]	shipmentReferences	The list of shipment references for which detail information is requested.
Boolean	withCanceledShipments	Controls, if canceled shipments should also be returned.

Fields inherited from class de.aeb.xnsg.foundation.bf.AbstractRequestDTO

clientIdentCode, clientSystemId, resultLanguageIsoCodes, userName

Constructor Summary

Constructors

Constructor	Description
DLGetShipmentsRequestDTO()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SHIPMENTS

public static final int MAX_SHIPMENTS

Maximum number of shipments that can be requested.

See Also:

Constant Field Values

shipmentReferences

public DLShipmentReferenceDTO[] shipmentReferences

The list of shipment references for which detail information is requested. Cannot be used with the filter at the same time.

includeDocuments

public Boolean includeDocuments

Controls, if the (label) documents should be included in the response of each shipment. Default is 'false'.

withCanceledShipments

public Boolean withCanceledShipments

Controls, if canceled shipments should also be returned. Default is 'true'.

filter

public DLShipmentFilterDTO filter

Controls, which shipments should be returned. Cannot be used with shipment references at the same time.

Constructor Detail

DLGetShipmentsRequestDTO

public DLGetShipmentsRequestDTO()