Package de.aeb.xnsg.lis20.bf

Class LISConsignmentRequest20DTO

java.lang.Object
de.aeb.xnsg.lis20.bf.LISConsignmentRequest20DTO
public class LISConsignmentRequest20DTO extends Object
DTO with parameters to request a list of consignments

  • Field Details

    • DATE_FILTER_EXP_DEL_DATE

      public static final String DATE_FILTER_EXP_DEL_DATE
      Date filter "EXPECTED_DELIVERY_DATE"
      See Also:

    • DATE_FILTER_PLANNED_DEL_DATE

      public static final String DATE_FILTER_PLANNED_DEL_DATE
      Date filter "PLANNED_DELIVERY_DATE"
      See Also:

    • DATE_FILTER_EXP_SHIP_DATE

      public static final String DATE_FILTER_EXP_SHIP_DATE
      Date filter "EXPECTED_SHIPPING_DATE"
      See Also:

    • DATE_FILTER_PLANNED_SHIP_DATE

      public static final String DATE_FILTER_PLANNED_SHIP_DATE
      Date filter "PLANNED_SHIPPING_DATE"
      See Also:

    • SORT_FIELD_CONSIGNMENT_NUMBER

      public static final String SORT_FIELD_CONSIGNMENT_NUMBER
      Sort field "CONSIGNMENT_NUMBER"
      See Also:

    • SORT_FIELD_EXP_SHIP_DATE

      public static final String SORT_FIELD_EXP_SHIP_DATE
      Sort field "EXPECTED_SHIPPING_DATE"
      See Also:

    • SORT_DIRECTION_ASC

      public static final String SORT_DIRECTION_ASC
      Sort direction "ASC"
      See Also:

    • SORT_DIRECTION_DESC

      public static final String SORT_DIRECTION_DESC
      Sort direction "DESC"
      See Also:

    • PROBLEM_FILTER_INFO

      public static final String PROBLEM_FILTER_INFO
      Problem filter "INFO"
      See Also:

    • PROBLEM_FILTER_ERROR

      public static final String PROBLEM_FILTER_ERROR
      Problem filter "ERROR"
      See Also:

    • PROBLEM_FILTER_FATAL_ERROR

      public static final String PROBLEM_FILTER_FATAL_ERROR
      Problem filter "FATAL_ERROR"
      See Also:

    • PROBLEM_FILTER_WARNING

      public static final String PROBLEM_FILTER_WARNING
      Problem filter "WARNING"
      See Also:

    • PROBLEM_FILTER_CANCELED

      public static final String PROBLEM_FILTER_CANCELED
      Problem filter "CANCELED"
      See Also:

    • MAX_RESULT_SIZE

      public static final Integer MAX_RESULT_SIZE
      The maximum number of consignments that can be returned. Thus the maximum value for field "maxNumberOfCons" and the default value if the field is empty.

    • identificationDTO

      public LISRequestIdentification20DTO identificationDTO
      The identification parameters of the request.

      The user is mandatory, determines also the filter profile which will be used as an additional select criteria to prevent access to unallowed consignments.
      The language is also mandatory, a part of the result data (e.g. the status names) will be returned in this language.

    • dateFrom

      public String dateFrom
      Date filter for the search, only consignments from this date on will be included in the search result. This is a mandatory field.
      The format of the date has to be "yyyy-MM-dd"

      length=10

    • dateTo

      public String dateTo
      Date filter for the search, only consignments up to this date will be included in the search result.
      If the field is empty, the actual date is assumed.
      The format of the date has to be "yyyy-MM-dd"

      length=10

    • dateField

      public String dateField
      The date field of the consignment, the date filter will be applied to. This is a mandatory field.
      Must be one of these values:
      • "EXPECTED_SHIPPING_DATE"
      • "PLANNED_SHIPPING_DATE"
      • "EXPECTED_DELIVERY_DATE"
      • "PLANNED_DELIVERY_DATE"

    • sortField

      public String sortField
      The field used to sort the result consignment list. Valid values are:
      • "CONSIGNMENT_NUMBER"
      • "EXPECTED_SHIPPING_DATE"
      "CONSIGNMENTNUMBER" is the default, when no value is specified.

    • sortDirection

      public String sortDirection
      The direction the consignments are sorted by their sortField. Valid values are:
      • "ASC" ascending
      • "DESC" descending

    • problemLevelFilter

      public String[] problemLevelFilter
      Problem level filter. When left empty, all found consignments will be returned, otherwise only the consignments with the specified problem levels will be returned. Valid values are:
      • "INFO"
      • "ERROR"
      • "FATERROR"
      • "WARNING"
      • "CANCELED"

    • consigneeNameFilter

      public String consigneeNameFilter
      Consignee filter. When filled, only consignments with the specified consignee name will be returned.

    • forwarderDeliveryNameFilter

      public String forwarderDeliveryNameFilter
      Forwarder filter. When filled, only consignments with the specified name for the delivering forwarder will be returned.

    • maxNumberOfCons

      public Integer maxNumberOfCons
      Specifies the maximal number of consignments the result list can include. Should prevent, that the result list will bee too large. Therefore a default of 50 will be assumed, when no value is specified. An error will be returned if the given number is greater than 50.

  • Constructor Details

    • LISConsignmentRequest20DTO

      public LISConsignmentRequest20DTO()