Class TrackingInfo

• Object
  • dw.object.Extensible
    • dw.order.TrackingInfo

Provides basic information about a tracking info. An instance is identified by an ID and can be referenced from n ShippingOrderItems using TrackingRefs. This also allows one ShippingOrderItem to be associated with n TrackingInfo.

See Also:

ShippingOrder.addTrackingInfo(String)

ShippingOrderItem.addTrackingRef(String, Quantity)

Properties

carrier : String

Get the Carrier.

carrierService : String

Get the service(ship method) of the used carrier.

ID : String Read Only

Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from TrackingRefs. To support short shipping a shipping-order-item can manage a list of TrackingRefs, each with an optional quantity value allowing individual items to ship in multiple parcels with known item quantity in each.

shipDate : Date

Get the ship date.

shippingOrder : ShippingOrder Read Only

Gets the shipping order.

trackingNumber : String

Get the tracking number.

trackingRefs : Collection Read Only

Gets the tracking refs (shipping order items) which are assigned to this tracking info.

warehouseID : String

Get the id of the shipping warehouse.

Constructor Summary

This class does not have a constructor, so you cannot create it directly.

Method Summary

getCarrier() : String

Get the Carrier.

getCarrierService() : String

Get the service(ship method) of the used carrier.

getID() : String

Get the mandatory identifier for this tracking information.

getShipDate() : Date

Get the ship date.

getShippingOrder() : ShippingOrder

Gets the shipping order.

getTrackingNumber() : String

Get the tracking number.

getTrackingRefs() : Collection

Gets the tracking refs (shipping order items) which are assigned to this tracking info.

getWarehouseID() : String

Get the id of the shipping warehouse.

setCarrier(carrier : String) : void

Set the Carrier.

setCarrierService(carrierService : String) : void

Set the service(ship method) of the used carrier.

setShipDate(shipDate : Date) : void

Set the ship date.

setTrackingNumber(trackingNumber : String) : void

Set the TrackingNumber.

setWarehouseID(warehouseID : String) : void

Set the id of the shipping warehouse.

Methods inherited from class Extensible

describe, getCustom

Methods inherited from class Object

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Method Detail

getCarrier

getCarrier() : String

Get the Carrier.

Returns:

the Carrier

getCarrierService

getCarrierService() : String

Get the service(ship method) of the used carrier.

Returns:

the carrier service (ship method)

getID

getID() : String

Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from TrackingRefs. To support short shipping a shipping-order-item can manage a list of TrackingRefs, each with an optional quantity value allowing individual items to ship in multiple parcels with known item quantity in each.

Returns:

the id

See Also:

ShippingOrder.addTrackingInfo(String)

getShipDate

getShipDate() : Date

Get the ship date.

Returns:

the ship date

getShippingOrder

getShippingOrder() : ShippingOrder

Gets the shipping order.

Returns:

the shipping order

getTrackingNumber

getTrackingNumber() : String

Get the tracking number.

Returns:

the TrackingNumber

getTrackingRefs

getTrackingRefs() : Collection

Gets the tracking refs (shipping order items) which are assigned to this tracking info.

Returns:

the tracking refs (shipping order items) which are assigned to this tracking info.

getWarehouseID

getWarehouseID() : String

Get the id of the shipping warehouse.

Returns:

the id of the shipping warehouse

setCarrier

setCarrier(carrier : String) : void

Set the Carrier.

Parameters:

carrier - the Carrier

setCarrierService

setCarrierService(carrierService : String) : void

Set the service(ship method) of the used carrier.

Parameters:

carrierService - the carrier service, eg. the ship method

setShipDate

setShipDate(shipDate : Date) : void

Set the ship date.

Parameters:

shipDate - the ship date

setTrackingNumber

setTrackingNumber(trackingNumber : String) : void

Set the TrackingNumber.

Parameters:

trackingNumber - the TrackingNumber

setWarehouseID

setWarehouseID(warehouseID : String) : void

Set the id of the shipping warehouse.

Parameters:

warehouseID - the id of the shipping warehouse