Represents an order line item.

Namespace:  BargeEx
Assembly:  BargeEx (in BargeEx.dll)
Version: 3.0.400.140 (3.0.400.140)

Syntax

C#
[SerializableAttribute]
public class OrderLineItem : CommonLineItem
Visual Basic (Declaration)
<SerializableAttribute> _
Public Class OrderLineItem _
	Inherits CommonLineItem
Visual C++
[SerializableAttribute]
public ref class OrderLineItem : public CommonLineItem

Remarks

This class represents an order line item.

Each order line item has a line item type, indicated by the LineItemType property, and some properties of the OrderLineItem class are only applicable to certain line item types. The following chart indicates which of these properties are applicable for the different CicaBargeEventStatusType values:

Status Type
Properties Assist BreakTow Clean CoverHandling Fleeting Load MakeTow MidstreamIn MidstreamOut Other Pump Repair Shift Unload
AssistType












CargoCustomerName
CargoCustomerIdentifier












CleanType












CommodityName
CommodityMappedName
CommodityCode











CommodityQuantity
CommodityQuantityUnitCode











CoverHandlingType












LineBoatName
LineBoatMappedName
LineBoatCoastGuardNumber









OtherOrderType












PumpType












RepairType












ToLocationName
ToLocationMappedName
ToLocationCode
ToLocationShipName
ToLocationMappedShipName
ToLocationShipImoNumber













WaterwayName
WaterwayMappedName
WaterwayCode
WaterwayMile
WaterwayDirection
WaterwayLatitude
WaterwayLongitude








Examples

The following example creates an instance of the OrderLineItem class and sets its common properties.
CopyVisual Basic
' Create a new BargeEx OrderLineItem object
Dim OrderLineItem As New BargeEx.OrderLineItem()

' Update the OrderLineItem's properties
With OrderLineItem

    ' Set the LineItem Details properties
    .LineItemNumber = 1
    .EstimatedDateTime = DateTime.Parse("01/01/2008 16:00")
    .Note = "OrderLineItem test note."

    ' Set the EventStatusType
    .LineItemType = BargeEx.CicaBargeEventStatusType.Assist

    ' Set Locaiton properties
    .LocationName = "Soap Dock #2"

    ' Set Waterway properties
    .WaterwayName = "Ohio River"
    .WaterwayMile = 123

    ' Set LineBoat properties
    .LineBoatName = "The Dan Brown"

    ' Set Commodity properties
    .CommodityName = "Soap"

End With ' OrderLineItem
CopyC#
// Create a new BargeEx OrderLineItem object
BargeEx.OrderLineItem OrderLineItem = new BargeEx.OrderLineItem();

// Update the OrderLineItem's properties
// Set the LineItem Details properties
OrderLineItem.LineItemNumber = 1;
OrderLineItem.EstimatedDateTime = DateTime.Parse("01/01/2008 16:00");
OrderLineItem.Note = "OrderLineItem test note.";

// Set the EventStatusType
OrderLineItem.LineItemType = BargeEx.CicaBargeEventStatusType.Assist;

// Set Locaiton properties
OrderLineItem.LocationName = "Soap Dock #2";

// Set Waterway properties
OrderLineItem.WaterwayName = "Ohio River";
OrderLineItem.WaterwayMile = 123;

// Set LineBoat properties
OrderLineItem.LineBoatName = "The Dan Brown";

// Set Commodity properties
OrderLineItem.CommodityName = "Soap";

Inheritance Hierarchy

See Also