Index (Routing_ClientIF.1.0 20240307

A B C D E G H I L M N P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractRoutingTaskResultResponseDTO - Class in de.aeb.xnsg.simplerouting.bf: Abstract response DTO superclass for a routing task result
AbstractRoutingTaskResultResponseDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.AbstractRoutingTaskResultResponseDTO
addFreightCalculationData - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: Additional and custom fields for Logistics Cost Management.
addFreightCalculationData - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: Additional and custom fields for Logistics Cost Management.
additionalInfo - Variable in class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO: Additional information about the route schedule.
additionalInfo - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDTO: Additional information about the supplement.
address - Variable in class de.aeb.xnsg.simplerouting.bf.HandoverPointDTO: The address of a handover point
address - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingPartyDTO: Address data of the party.
address - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskLocationDTO: The address data.

B

BillingAdditionalFreightCalculationDataDTO - Class in de.aeb.xnsg.simplerouting.bf: The BillingAdditionalFreightCalculationDataDTO provides data to send to Logistics Costs Management.
BillingAdditionalFreightCalculationDataDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.BillingAdditionalFreightCalculationDataDTO

C

CarrierDTO - Class in de.aeb.xnsg.simplerouting.bf: Representation of a carrier.
This DTO is ONLY used for the master file business facade call: IRoutingBF.getAllCarriers(GetAllCarriersRequestDTO)

It is not used for the other calls.
CarrierDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.CarrierDTO
carriers - Variable in class de.aeb.xnsg.simplerouting.bf.GetAllCarriersResponseDTO: List of all carriers available for the target client as configured in the Routing engine.
city - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingAddressDTO: City of the address.
configurationIdentCode - Variable in class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO: Identcode of configuration used to calculate this DTO.
configurationIdentCode - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingScheduleTypeDTO: The configuration ident code for the schedule configuration.
confirmedDeliveryDate - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: Confirmed delivery date of the routing task as timestamp and zone.
confirmedDeliveryDate - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: Confirmed delivery date of the supplement task as timestamp and zone.
countryISOCode - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingAddressDTO: Country of address
createRoutingTask(CreateRoutingTaskRequestDTO) - Method in interface de.aeb.xnsg.simplerouting.bf.IRoutingBF: Creates a new routing task and returns a unique task id.

In case of successful creation, the response will contain the unique taskId of the created routing task.
CreateRoutingTaskRequestDTO - Class in de.aeb.xnsg.simplerouting.bf: Request DTO for createRoutingTask business facade method IRoutingBF.createRoutingTask(CreateRoutingTaskRequestDTO).
CreateRoutingTaskRequestDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.CreateRoutingTaskRequestDTO
CreateRoutingTaskResponseDTO - Class in de.aeb.xnsg.simplerouting.bf: Response DTO for createRoutingTask business facade method IRoutingBF.createRoutingTask(CreateRoutingTaskRequestDTO).
CreateRoutingTaskResponseDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.CreateRoutingTaskResponseDTO
createSupplementTask(CreateSupplementTaskRequestDTO) - Method in interface de.aeb.xnsg.simplerouting.bf.IRoutingBF: Creates a new supplement task and returns a unique task id.

In case of successful creation, the response will contain the unique taskId of the created supplement task.
CreateSupplementTaskRequestDTO - Class in de.aeb.xnsg.simplerouting.bf: Request DTO for createSupplementTask business facade method IRoutingBF.createSupplementTask(CreateSupplementTaskRequestDTO).
CreateSupplementTaskRequestDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.CreateSupplementTaskRequestDTO
CreateSupplementTaskResponseDTO - Class in de.aeb.xnsg.simplerouting.bf: Response DTO for createSupplementTask business facade method IRoutingBF.createSupplementTask(CreateSupplementTaskRequestDTO).
CreateSupplementTaskResponseDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.CreateSupplementTaskResponseDTO
currencyIsoCode - Variable in class de.aeb.xnsg.simplerouting.bf.PricingSupplementDataDTO: Currency of calculated price in client currency.
CusBillingFieldDTO - Class in de.aeb.xnsg.simplerouting.bf: This is a standard DTO class, which holds customized content.
CusBillingFieldDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.CusBillingFieldDTO
cusBillingFields - Variable in class de.aeb.xnsg.simplerouting.bf.BillingAdditionalFreightCalculationDataDTO: Custom fields for Logistics Cost Management.
customsValue - Variable in class de.aeb.xnsg.simplerouting.bf.BillingAdditionalFreightCalculationDataDTO: customs value.

D

DANGEROUS_GOODS_CODE_EQ - Static variable in class de.aeb.xnsg.simplerouting.bf.DangerousGoodsCodeDTO
DANGEROUS_GOODS_CODE_LQ - Static variable in class de.aeb.xnsg.simplerouting.bf.DangerousGoodsCodeDTO
DANGEROUS_GOODS_CODE_NONE - Static variable in class de.aeb.xnsg.simplerouting.bf.DangerousGoodsCodeDTO
DANGEROUS_GOODS_CODE_NORMAL - Static variable in class de.aeb.xnsg.simplerouting.bf.DangerousGoodsCodeDTO
dangerousGoodsCode - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskHandlingUnitDTO: Dangerous goods data concerning the handling unit.
DangerousGoodsCodeDTO - Class in de.aeb.xnsg.simplerouting.bf: Information about dangerous goods.
DangerousGoodsCodeDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.DangerousGoodsCodeDTO
data - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDTO: Holds three fields where each field contains individual data depending on its type.
dataType - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDTO: Data type contains (simple) name of class of the data holding field in RoutingSupplementDataDTO.
dataType - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementTypeDTO: Class short name of SupplementDataDTO e.g.
DATE_TIME_FORMAT - Static variable in class de.aeb.xnsg.simplerouting.bf.CusBillingFieldDTO: Constant for dateTime format: "yyyy-MM-dd'T'HH:mm:ss"
de.aeb.xnsg.simplerouting.bf - package de.aeb.xnsg.simplerouting.bf
decisiveDate - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: The string representation of the Date in the format yyyy-MM-dd.
decisiveDate - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: The string representation of the Date in the format yyyy-MM-dd.
deliveryPriority - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: Delivery priority or delivery condition.
deliveryPriority - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: Delivery priority or delivery condition.
descriptions - Variable in class de.aeb.xnsg.simplerouting.bf.HandoverPointDTO: Multi-language descriptions of the handover point
descriptions - Variable in class de.aeb.xnsg.simplerouting.bf.RatingProfileDTO: Multi-language descriptions of this RatingProfile
descriptions - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingRequirementInTypeDTO: Multi-language descriptions of this requirement
descriptions - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingRequirementTypeDTO: Multi-language descriptions for this type
distance - Variable in class de.aeb.xnsg.simplerouting.bf.BillingAdditionalFreightCalculationDataDTO: Distance of the transport relation, precalculated by the client system.

E

earliestDeliveryDate - Variable in class de.aeb.xnsg.simplerouting.bf.RouteLegScheduleDTO: The calculated earliest delivery date.
earliestDeliveryDate - Variable in class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO: The calculated earliest delivery date.
earliestShippingDate - Variable in class de.aeb.xnsg.simplerouting.bf.RouteLegScheduleDTO: The calculated earliest shipping date.
earliestShippingDate - Variable in class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO: The calculated earliest shipping date.
effectiveSupplements - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingProposalDTO: Array of supplements for this routing proposal.
endHop - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingLegProposalDTO: The handover point where the leg ends.
endLocation - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO
endLocation - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO

G

getAllCarriers(GetAllCarriersRequestDTO) - Method in interface de.aeb.xnsg.simplerouting.bf.IRoutingBF: Returns all carriers available for the target client.

This call might help to find the correct identCode of a carrier and service as well as the value-added services belonging to that carrier, which shall be added to the supplement task by using IRoutingBF.createSupplementTask(CreateSupplementTaskRequestDTO).
GetAllCarriersRequestDTO - Class in de.aeb.xnsg.simplerouting.bf: Request DTO to access all carriers existing for the given target client in the Routing engine.
GetAllCarriersRequestDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.GetAllCarriersRequestDTO
GetAllCarriersResponseDTO - Class in de.aeb.xnsg.simplerouting.bf: ResponseDTO of carrier business facade call
GetAllCarriersResponseDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.GetAllCarriersResponseDTO
getHandoverPoints(GetHandoverPointsRequestDTO) - Method in interface de.aeb.xnsg.simplerouting.bf.IRoutingBF: Returns all handover points available for the target client.

Handover points are master file data.
GetHandoverPointsRequestDTO - Class in de.aeb.xnsg.simplerouting.bf: Request DTO to access all handover points existing for the given target client in the Routing engine.
GetHandoverPointsRequestDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.GetHandoverPointsRequestDTO
GetHandoverPointsResponseDTO - Class in de.aeb.xnsg.simplerouting.bf: ResponseDTO of handover point business facade call
GetHandoverPointsResponseDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.GetHandoverPointsResponseDTO
getRatingProfiles(GetRatingProfilesRequestDTO) - Method in interface de.aeb.xnsg.simplerouting.bf.IRoutingBF: Returns all rating profiles available for the target client.

This call might help to find the correct identCode of a rating profile, which shall be added to the routing task by using IRoutingBF.createRoutingTask(CreateRoutingTaskRequestDTO).
GetRatingProfilesRequestDTO - Class in de.aeb.xnsg.simplerouting.bf: Request DTO to access all rating profiles configured for the given target client in the Routing engine.
GetRatingProfilesRequestDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.GetRatingProfilesRequestDTO
GetRatingProfilesResponseDTO - Class in de.aeb.xnsg.simplerouting.bf: ResponseDTO for rating profiles returned by IRoutingBF.getRatingProfiles(GetRatingProfilesRequestDTO).
GetRatingProfilesResponseDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.GetRatingProfilesResponseDTO
getRejectedRoutingTaskResult(GetRoutingTaskResultRequestDTO) - Method in interface de.aeb.xnsg.simplerouting.bf.IRoutingBF: Returns a sorted list of the rejected proposals for the provided task id and its current calculation state.
The rejected proposals are those proposals which were filtered out according to the settings in the rating profile.

Possible states of calculation are:
- INPROGRESS: entries (and ordering) might change in future calls.
getRoutingRequirementTypes(GetRoutingRequirementTypesRequestDTO) - Method in interface de.aeb.xnsg.simplerouting.bf.IRoutingBF: Returns all requirements and requirement types available for the target client.

This call might help to find the correct identCode of a requirement, which shall be added to the routing task by using IRoutingBF.createRoutingTask(CreateRoutingTaskRequestDTO).
GetRoutingRequirementTypesRequestDTO - Class in de.aeb.xnsg.simplerouting.bf: Request DTO to access all requirement types configured for the given target client in the Routing engine.
GetRoutingRequirementTypesRequestDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.GetRoutingRequirementTypesRequestDTO
GetRoutingRequirementTypesResponseDTO - Class in de.aeb.xnsg.simplerouting.bf: ResponseDTO for requirements returned by IRoutingBF.getRoutingRequirementTypes(GetRoutingRequirementTypesRequestDTO).
GetRoutingRequirementTypesResponseDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.GetRoutingRequirementTypesResponseDTO
getRoutingTaskResult(GetRoutingTaskResultRequestDTO) - Method in interface de.aeb.xnsg.simplerouting.bf.IRoutingBF: Returns a sorted list of proposals for the provided task id and its current calculation state.

The final list of proposals is ranked according to a rating profile.
GetRoutingTaskResultRequestDTO - Class in de.aeb.xnsg.simplerouting.bf: Request DTO to get the a list of ranked proposals and the current calculation status for the routing task defined by the provided task id.
GetRoutingTaskResultRequestDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.GetRoutingTaskResultRequestDTO
GetRoutingTaskResultResponseDTO - Class in de.aeb.xnsg.simplerouting.bf: Response DTO of IRoutingBF.getRoutingTaskResult(GetRoutingTaskResultRequestDTO).
GetRoutingTaskResultResponseDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.GetRoutingTaskResultResponseDTO
getSupplementTaskResult(GetSupplementTaskResultRequestDTO) - Method in interface de.aeb.xnsg.simplerouting.bf.IRoutingBF: Returns an intermediate result of calculated supplements for the provided task id and its current calculation state.

Possible states of calculation are:
- INPROGRESS: entries (and ordering) might change in future calls.
GetSupplementTaskResultRequestDTO - Class in de.aeb.xnsg.simplerouting.bf: Request DTO to get the current calculation status for the supplement task defined by the provided task id.
GetSupplementTaskResultRequestDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.GetSupplementTaskResultRequestDTO
GetSupplementTaskResultResponseDTO - Class in de.aeb.xnsg.simplerouting.bf: Response DTO of IRoutingBF.getSupplementTaskResult(GetSupplementTaskResultRequestDTO).
GetSupplementTaskResultResponseDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.GetSupplementTaskResultResponseDTO
goodsValue - Variable in class de.aeb.xnsg.simplerouting.bf.BillingAdditionalFreightCalculationDataDTO: goods value.

H

handlingCode - Variable in class de.aeb.xnsg.simplerouting.bf.DangerousGoodsCodeDTO: Indicates the type of dangerous goods Valid values are: NONE (no dangerous goods) NORMAL (dangerous goods) LQ (limited quantities) EQ (excepted quantities)
handlingUnits - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: The handling units of the routing task.
handlingUnits - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: The handling units of the supplement task.
handlingUnitType - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskHandlingUnitDTO: The identCode of the handling unit type.
HandoverPointDTO - Class in de.aeb.xnsg.simplerouting.bf: Representation of an handover point.
This DTO is ONLY used for the master file business facade call: IRoutingBF.getHandoverPoints(GetHandoverPointRequestDTO)

It is not used for the other calls.
HandoverPointDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.HandoverPointDTO
handoverPoints - Variable in class de.aeb.xnsg.simplerouting.bf.GetHandoverPointsResponseDTO: List of all handover points available for the target client as configured in the Routing engine.
HopDTO - Class in de.aeb.xnsg.simplerouting.bf: Representation of an handover point
HopDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.HopDTO
HopEndDTO - Class in de.aeb.xnsg.simplerouting.bf: Representation of an undefined handover point representing the last legs end
HopEndDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.HopEndDTO
hopRef - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskLocationDTO: Reference to a handover point.
HopReferenceDTO - Class in de.aeb.xnsg.simplerouting.bf: Representation of a handover point as a defined entity
HopReferenceDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.HopReferenceDTO
HopStartDTO - Class in de.aeb.xnsg.simplerouting.bf: Representation of an undefined handover point representing the first legs start
HopStartDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.HopStartDTO

I

identCode - Variable in class de.aeb.xnsg.simplerouting.bf.CarrierDTO: Ident code of a carrier
identCode - Variable in class de.aeb.xnsg.simplerouting.bf.HandoverPointDTO: Ident code of the handover point
identCode - Variable in class de.aeb.xnsg.simplerouting.bf.HopReferenceDTO: IdentCode of the hand over point
identCode - Variable in class de.aeb.xnsg.simplerouting.bf.RatingProfileDTO: Ident code of the rating profile
identCode - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingRequirementInTypeDTO: Unique identification code of this requirement
identCode - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingRequirementTypeDTO: Unique requirement type ident code.
identCode - Variable in class de.aeb.xnsg.simplerouting.bf.ServiceInfoDTO: Ident code of the service
identCode - Variable in class de.aeb.xnsg.simplerouting.bf.ValueAddedServiceDTO: Ident code of the value-added service
internalId - Variable in class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO: The unique ID of the route schedule.
internalId - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingLegProposalDTO: The unique ID of the leg proposal.
IRoutingBF - Interface in de.aeb.xnsg.simplerouting.bf: Routing related business facade methods.
isDocumentShipment - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: Indicates whether the routing task is a document shipment or goods shipment.
If true, the shipment is a document shipment.
If false, the shipment is a goods shipment.
False (= goods shipment) is the default when no value is supplied.
isDocumentShipment - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: Indicates whether the supplement task is a document shipment or goods shipment.
If true, the shipment is a document shipment.
If false, the shipment is a goods shipment.
False (= goods shipment) is the default when no value is supplied.

L

latestDeliveryDate - Variable in class de.aeb.xnsg.simplerouting.bf.RouteLegScheduleDTO: The calculated latest delivery date.
latestDeliveryDate - Variable in class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO: The calculated latest delivery date.
latestShippingDate - Variable in class de.aeb.xnsg.simplerouting.bf.RouteLegScheduleDTO: The calculated latest shipping date.
latestShippingDate - Variable in class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO: The calculated latest shipping date.
legs - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingProposalDTO: The legs ('parts') of a whole transport chain.
legSchedule - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingLegProposalDTO: Schedule calculation information of the individual proposal legs.
loadingMeters - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: The loading meters of the routing task.
loadingMeters - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: The loading meters of the supplement task.

M

modeOfTransportIdentCode - Variable in class de.aeb.xnsg.simplerouting.bf.BillingAdditionalFreightCalculationDataDTO: Identifier for the mode of transport.

N

name - Variable in class de.aeb.xnsg.simplerouting.bf.CusBillingFieldDTO: Name of the field.
name - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingAddressDTO: First address line
name - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDTO: Name of this supplement as configured the Routing Engine.
name - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementTypeDTO: Unique name of supplement
numberOfDeliveryNotes - Variable in class de.aeb.xnsg.simplerouting.bf.BillingAdditionalFreightCalculationDataDTO: represents the number of delivery notes.
numberOfHandlingUnits - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskHandlingUnitDTO: Number of handling units.
numberOfInvoices - Variable in class de.aeb.xnsg.simplerouting.bf.BillingAdditionalFreightCalculationDataDTO: represents the number of invoices.

P

palletPlaces - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: The pallet places of the routing task.
palletPlaces - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: The pallet places of the supplement task.
parties - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: The parties of the routing task.
parties - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: The parties of the supplement task.
PARTY_ROLE_CONSIGNEE - Static variable in class de.aeb.xnsg.simplerouting.bf.RoutingPartyDTO: "CONSIGNEE"
PARTY_ROLE_PICKUP_ADDRESS - Static variable in class de.aeb.xnsg.simplerouting.bf.RoutingPartyDTO: "PICKUPADDRESS"
PARTY_ROLE_SHIPPER - Static variable in class de.aeb.xnsg.simplerouting.bf.RoutingPartyDTO: "SHIPPER"
PARTY_ROLE_SHIPPING_POINT - Static variable in class de.aeb.xnsg.simplerouting.bf.RoutingPartyDTO: "SHIPPINGPOINT"
partyRole - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingPartyDTO: Role of the location, might be shipping point, consignee.
postcode - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingAddressDTO: Postcode of the address.
pricingData - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDataDTO: Price information.
PricingSupplementDataDTO - Class in de.aeb.xnsg.simplerouting.bf: Price information.
PricingSupplementDataDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.PricingSupplementDataDTO
procedureIndicator - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: (Special) procedure indicator.
procedureIndicator - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: (Special) procedure indicator.
profiles - Variable in class de.aeb.xnsg.simplerouting.bf.GetRatingProfilesResponseDTO: List of all rating profiles available for the target client as configured in the Routing engine.
proposals - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskResultDTO: List of proposals calculated by the Routing engine.

R

ratingProfile - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingParmsDTO: The ident code of the profile that will be used in routing.
RatingProfileDTO - Class in de.aeb.xnsg.simplerouting.bf: DTO representation of a rating profile
RatingProfileDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RatingProfileDTO
readyForShippingDate - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: Ready for shipping date as timestamp and zone.
readyForShippingDate - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: Ready for shipping date as timestamp and zone.
referenceCode - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingAddressDTO: Reference code,
referenceNumber - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: The clients reference number for the task.
referenceNumber - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskResultDTO: The reference number for the routing task.
referenceNumber - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: The clients reference number for the task.
referenceNumber - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskResultDTO: The reference number for the supplement task.
requirementCode - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingRequirementDTO: Name of requirement.
for example: Economy, Standard, Express Sea, Road, Air A, B, C Cash, Cheque,
requirements - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingRequirementTypeDTO: Routing requirements contained in this type
requirements - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: The requirements of the routing task.
requirementType - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingRequirementDTO: Type of requirement.
for example: serviceLevel, mode of transport, special treatment COD, insurance
RouteLegScheduleDTO - Class in de.aeb.xnsg.simplerouting.bf: DTO to provide a leg of a route schedule calculation.
RouteLegScheduleDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RouteLegScheduleDTO
routeSchedule - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingProposalDTO: Schedule calculation information of the proposal.
routeSchedule - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskResultDTO: Schedule calculation information of the route.
RouteScheduleDTO - Class in de.aeb.xnsg.simplerouting.bf: DTO to provide a result of a schedule calculation.
RouteScheduleDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO
RoutingAddressDTO - Class in de.aeb.xnsg.simplerouting.bf: DTO to provide address data
RoutingAddressDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingAddressDTO
RoutingLegProposalDTO - Class in de.aeb.xnsg.simplerouting.bf: Describes one leg ('part') of a whole transport chain.
RoutingLegProposalDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingLegProposalDTO
routingParms - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: The parms for routing.
routingParms - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: The parms for routing.
RoutingParmsDTO - Class in de.aeb.xnsg.simplerouting.bf: Detailed settings for proposal, supplement and ranking calculations.
RoutingParmsDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingParmsDTO
RoutingPartyDTO - Class in de.aeb.xnsg.simplerouting.bf: A party contains a company with information on the address of the given party.
RoutingPartyDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingPartyDTO
RoutingProposalDTO - Class in de.aeb.xnsg.simplerouting.bf: Main DTO to hold data on a proposal.
Each leg contains information on services enriched with supplements as additional information.
RoutingProposalDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingProposalDTO
RoutingRequirementDTO - Class in de.aeb.xnsg.simplerouting.bf: Requirements are classified by a requirementType.
RoutingRequirementDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingRequirementDTO
RoutingRequirementInTypeDTO - Class in de.aeb.xnsg.simplerouting.bf: DTO representation of a routing requirement contained in a routing requirement type.
This DTO is used in context of getting a list of all available requirements available for a target client: IRoutingBF.getRoutingRequirementTypes(GetRoutingRequirementTypesRequestDTO).
RoutingRequirementInTypeDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingRequirementInTypeDTO
RoutingRequirementTypeDTO - Class in de.aeb.xnsg.simplerouting.bf: DTO representation of a routing requirement type.
This DTO is used in context of getting a list of all available requirements available for a target client: IRoutingBF.getRoutingRequirementTypes(GetRoutingRequirementTypesRequestDTO).
RoutingRequirementTypeDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingRequirementTypeDTO
RoutingScheduleTypeDTO - Class in de.aeb.xnsg.simplerouting.bf: Holds a reference of a schedule configuration.
RoutingScheduleTypeDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingScheduleTypeDTO
RoutingSupplementDataDTO - Class in de.aeb.xnsg.simplerouting.bf: Container class for all supplement dependent data for BF.
RoutingSupplementDataDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDataDTO
RoutingSupplementDTO - Class in de.aeb.xnsg.simplerouting.bf: This supplement DTO is a container for additional information.
RoutingSupplementDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDTO
RoutingSupplementTypeDTO - Class in de.aeb.xnsg.simplerouting.bf: Each supplement is characterized by a unique name defined by the user and its dataType.
RoutingSupplementTypeDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingSupplementTypeDTO
routingTask - Variable in class de.aeb.xnsg.simplerouting.bf.CreateRoutingTaskRequestDTO: The single routing task which should be routed.
RoutingTaskDTO - Class in de.aeb.xnsg.simplerouting.bf: The RoutingTaskDTO is the main representation of a routing task.
RoutingTaskDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO
RoutingTaskHandlingUnitDTO - Class in de.aeb.xnsg.simplerouting.bf: Basic data of a handling unit which shall be transported as defined in the RoutingTaskDTO.
RoutingTaskHandlingUnitDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingTaskHandlingUnitDTO
RoutingTaskLocationDTO - Class in de.aeb.xnsg.simplerouting.bf: Class for location based routing task data for BF.
RoutingTaskLocationDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingTaskLocationDTO
routingTaskResult - Variable in class de.aeb.xnsg.simplerouting.bf.AbstractRoutingTaskResultResponseDTO: Contains a list of ranked proposals and information on the current calculation status for the requested routing task.
RoutingTaskResultDTO - Class in de.aeb.xnsg.simplerouting.bf: Contains a list of ranked RoutingTaskResultDTO.proposals and information on the current calculation status for for the routing task with the given RoutingTaskResultDTO.taskId.
RoutingTaskResultDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.RoutingTaskResultDTO

S

SCHEDULE_ABORTED - Static variable in class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO: Carrier Select returns an exception.
SCHEDULE_ERROR - Static variable in class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO: An error was occurred in the subsequent systems.
SCHEDULE_EXCLUDED - Static variable in class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO: No schedule was calculated as too many service proposals were determined for the request.

The limit in schedule configuration has been exceeded.
SCHEDULE_PENDING - Static variable in class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO: The route schedule is still to be calculated.
SCHEDULE_PROCESSED - Static variable in class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO: Calculation is complete and has valid values.
score - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingProposalDTO: Score of the proposal.
service - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: The concrete service for which supplements need to be calculated.
service - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskResultDTO: The service of the supplement task.
ServiceDTO - Class in de.aeb.xnsg.simplerouting.bf
ServiceDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.ServiceDTO
serviceIdentCode - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingLegProposalDTO: IdentCode of the service
serviceIdentCode - Variable in class de.aeb.xnsg.simplerouting.bf.ServiceDTO: The ID of the service.
ServiceInfoDTO - Class in de.aeb.xnsg.simplerouting.bf: Representation of a service
ServiceInfoDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.ServiceInfoDTO
serviceInfoTextIdentCodes - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingLegProposalDTO: Array of identCodes of info texts
serviceProviderIdentCode - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingLegProposalDTO: IdentCode of the service provider.
serviceProviderIdentCode - Variable in class de.aeb.xnsg.simplerouting.bf.ServiceDTO: The ID of the provider.
services - Variable in class de.aeb.xnsg.simplerouting.bf.CarrierDTO: Array of identCodes of services.
ServiceVasValidationSupplementDataDTO - Class in de.aeb.xnsg.simplerouting.bf: Result of validation
ServiceVasValidationSupplementDataDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.ServiceVasValidationSupplementDataDTO
settlementPrices - Variable in class de.aeb.xnsg.simplerouting.bf.PricingSupplementDataDTO: Settlement prices, grouped by currency.
shippingCondition - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: Shipping condition.
shippingCondition - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: Shipping condition.
singleDimensions - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskHandlingUnitDTO: The dimensions of the package.
singleGrossWeight - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskHandlingUnitDTO: The gross weight of a single handling unit.
sortNumber - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingProposalDTO: 1,2,3,...
starRatingData - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDataDTO: Star rating
StarRatingSupplementDataDTO - Class in de.aeb.xnsg.simplerouting.bf: Star rating
StarRatingSupplementDataDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.StarRatingSupplementDataDTO
starRatingValue - Variable in class de.aeb.xnsg.simplerouting.bf.StarRatingSupplementDataDTO
startHop - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingLegProposalDTO: The handover point where at the leg starts.
startLocation - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO
startLocation - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO
state - Variable in class de.aeb.xnsg.simplerouting.bf.RouteScheduleDTO: Calculation state of this schedule.
state - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDTO: Calculation state of this supplement.
state - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskResultDTO: State of current proposal calculation, it can have the following states:
- INPROGRESS: RoutingTaskResultDTO.proposals (and ordering) might change in future calls.
- COMPLETE: ordering and entries fixed, all supplements calculated.
state - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskResultDTO: Possible states of calculation are:
- INPROGRESS: Some supplements have not been calculated yet.
- COMPLETE: All supplements have been calculated.
stateRegion - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingAddressDTO: The state or region
street - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingAddressDTO: Street (line 1) of the address.
SUPPLEMENT_ABORTED - Static variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDTO: Carrier Select returns an exception.
SUPPLEMENT_ERROR - Static variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDTO: An error was occurred in the subsequent systems.
SUPPLEMENT_PROCESSED - Static variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDTO: Calculation is complete and has valid values.
supplements - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingLegProposalDTO: Array of supplements for this leg proposal.
supplements - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskResultDTO: List of supplements for this service.
supplementTask - Variable in class de.aeb.xnsg.simplerouting.bf.CreateSupplementTaskRequestDTO
SupplementTaskDTO - Class in de.aeb.xnsg.simplerouting.bf: The SupplementTaskDTO is the main representation of a supplement task.
SupplementTaskDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO
supplementTaskResult - Variable in class de.aeb.xnsg.simplerouting.bf.GetSupplementTaskResultResponseDTO
SupplementTaskResultDTO - Class in de.aeb.xnsg.simplerouting.bf: Contains a list of calculated supplements and information on the current calculation status for for the supplement task with the given SupplementTaskResultDTO.taskId.
SupplementTaskResultDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.SupplementTaskResultDTO
supportedScheduleType - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskResultDTO: Information on schedule that is calculated for this routing task.
supportedSupplementTypes - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskResultDTO: List of supported supplements types that are calculated for this routing task.
supportedSupplementTypes - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskResultDTO: List of supported supplements types that are calculated for this supplement task.

T

taskId - Variable in class de.aeb.xnsg.simplerouting.bf.CreateRoutingTaskResponseDTO: The taskId is a unique value that is generated for a requested routing task.
taskId - Variable in class de.aeb.xnsg.simplerouting.bf.CreateSupplementTaskResponseDTO
taskId - Variable in class de.aeb.xnsg.simplerouting.bf.GetRoutingTaskResultRequestDTO: The task id is a unique value that was generated for the requested routing task.
taskId - Variable in class de.aeb.xnsg.simplerouting.bf.GetSupplementTaskResultRequestDTO
taskId - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskResultDTO: Unique taskId of the routing task.
taskId - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskResultDTO: Unique taskId of the supplement task.
termsOfDeliveryCode - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingTaskDTO: The clients terms of delivery code.
termsOfDeliveryCode - Variable in class de.aeb.xnsg.simplerouting.bf.SupplementTaskDTO: The clients terms of delivery code.
type - Variable in class de.aeb.xnsg.simplerouting.bf.CusBillingFieldDTO: type of the field.
TYPE_BOOLEAN - Static variable in class de.aeb.xnsg.simplerouting.bf.CusBillingFieldDTO: Constant for type 'boolean'
TYPE_DATETIME - Static variable in class de.aeb.xnsg.simplerouting.bf.CusBillingFieldDTO: Constant for type 'dateTime'
TYPE_DECIMAL - Static variable in class de.aeb.xnsg.simplerouting.bf.CusBillingFieldDTO: Constant for type 'decimal'.
TYPE_INT - Static variable in class de.aeb.xnsg.simplerouting.bf.CusBillingFieldDTO: Constant for type 'int'
TYPE_LONG - Static variable in class de.aeb.xnsg.simplerouting.bf.CusBillingFieldDTO: Constant for type 'long'
TYPE_STRING - Static variable in class de.aeb.xnsg.simplerouting.bf.CusBillingFieldDTO: Constant for type 'string'
types - Variable in class de.aeb.xnsg.simplerouting.bf.GetRoutingRequirementTypesResponseDTO: List of all requirement types available for the target client as configured in the Routing engine.

V

validationData - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDataDTO: Result on validation
validationResult - Variable in class de.aeb.xnsg.simplerouting.bf.ServiceVasValidationSupplementDataDTO
value - Variable in class de.aeb.xnsg.simplerouting.bf.CusBillingFieldDTO: Value of the custom field.
value - Variable in class de.aeb.xnsg.simplerouting.bf.PricingSupplementDataDTO: Value of calculated price in client currency.
value - Variable in class de.aeb.xnsg.simplerouting.bf.ValueRatingSupplementDataDTO
ValueAddedServiceDTO - Class in de.aeb.xnsg.simplerouting.bf: Representation of a value-added service.
ValueAddedServiceDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.ValueAddedServiceDTO
valueAddedServices - Variable in class de.aeb.xnsg.simplerouting.bf.CarrierDTO: Array of identCodes of value added services.
valueRatingData - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingSupplementDataDTO: Value rating
ValueRatingSupplementDataDTO - Class in de.aeb.xnsg.simplerouting.bf: Value rating.
ValueRatingSupplementDataDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.ValueRatingSupplementDataDTO
vasIdentCodes - Variable in class de.aeb.xnsg.simplerouting.bf.RoutingLegProposalDTO: Array of identCodes of value added services.
vasIdentCodes - Variable in class de.aeb.xnsg.simplerouting.bf.ServiceDTO: The IDs of the value added services.

W

waitForRoutingTaskResult(WaitForRoutingTaskResultRequestDTO) - Method in interface de.aeb.xnsg.simplerouting.bf.IRoutingBF: Waits for the task calculation to finish and returns a sorted list of proposals for the provided task id and its current calculation state.

If the calculation takes longer than the set waiting time limit, the list of proposals will be returned in its current unfinished calculation state as soon as the limit is reached.

The final list of proposals is ranked according to a rating profile.
WaitForRoutingTaskResultRequestDTO - Class in de.aeb.xnsg.simplerouting.bf: Request DTO to get the a list of ranked proposals and the current calculation status for the routing task defined by the provided task id.
WaitForRoutingTaskResultRequestDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.WaitForRoutingTaskResultRequestDTO
WaitForRoutingTaskResultResponseDTO - Class in de.aeb.xnsg.simplerouting.bf: Response DTO of IRoutingBF.waitForRoutingTaskResult(WaitForRoutingTaskResultRequestDTO).
WaitForRoutingTaskResultResponseDTO() - Constructor for class de.aeb.xnsg.simplerouting.bf.WaitForRoutingTaskResultResponseDTO
waitingTimeoutInSeconds - Variable in class de.aeb.xnsg.simplerouting.bf.WaitForRoutingTaskResultRequestDTO: Waiting timeout in seconds.

It indicates how long the response is going to take in case the routing task is not finished yet.

The waiting timeout has a limit which is 10 seconds by default.

Setting the timeout to 5 seconds should be sufficient in most cases.

A B C D E G H I L M N P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values