[SerializableAttribute]
public class BargeStatus : UpdatableBargeExDocumentBase

<SerializableAttribute> _
Public Class BargeStatus _
	Inherits UpdatableBargeExDocumentBase

[SerializableAttribute]
public ref class BargeStatus : public UpdatableBargeExDocumentBase

The Barge Status document provides a means for a marine trading partner to transmit the status of a barge to another marine trading partner. Status types include Clean, Load, Unload, Shift, Midstream, Pump, Repair, etc.

Each status message may relate to a Barge Service Order Document. Each status document may also relate to a Barge Invoice Document Line Item when the service provider bills for service rendered.

Each Barge Status document has a status type, indicated by the EventStatusType property, and some properties of the BargeStatus class are only applicable to certain barge status types. The following chart indicates which of these properties are applicable for the different CicaBargeEventStatusType values:

Status Type

Properties

Assist

BargeOnOrder

BreakTow

Clean

ConsignmentLocationChange

CoverHandling

Delay

Fleeting

Load

MakeTow

MidstreamIn

MidstreamOut

Other

PlacedToLoad

PlacedToUnload

Position

Pump

Released

Repair

Shift

Unload

CargoCustomerName CargoCustomerIdentifier

CargoTransferStatus

CleanType

CommodityQuantity CommodityQuantityUnitCode

CoverHandlingType

DelayType

EstimatedArrivalDateTime

LineBoatName LineBoatMappedName LineBoatCoastGuardNumber

LoadStatus

PrimaryTransactionIdentifier PrimaryTransactionRevision

PumpType

RepairType

ShiftType

ToLocationName ToLocationMappedName ToLocationCode ToLocationShipName ToLocationMappedShipName ToLocationShipImoNumber

WaterwayName WaterwayMappedName WaterwayCode WaterwayMile WaterwayDirection WaterwayLatitude WaterwayLongitude

The following example creates an instance of the BargeEx BargeStatus class and sets its common properties.

CopyVisual Basic

' Create a new BargeEx BargeStatus object
Dim BargeStatus As New BargeEx.BargeStatus()

' Update the BargeStatus properties before
' returning the object to the user
With BargeStatus

    ' Update the DocumentHeader property
    .Header.SenderTradingPartnerNumber = "12345678"
    .Header.ReceiverTradingPartnerNumber = "87654321"
    .Header.InstanceIdentifier = "ABC123"
    .Header.CreateDateTime = DateTime.Parse("01/01/2008 16:00")

    ' Set the ApplicationHeader properties
    .CreateDateTime = DateTime.Parse("01/01/2008 16:00")
    .TransactionIdentifier = "ABC123"
    .PurposeCode = BargeEx.CicaTransactionPurposeCode.NewTransaction
    .Note = "BargeStatus test note."
    .ResponsibleLocationName = "Fleeter ABC"

    ' Set the document's Event Information section
    .BargeName = "CSG123"

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

    ' Set the start and end date times
    .StartDateTime = DateTime.Parse("01/01/2008 16:00")
    .EndDateTime = DateTime.Parse("01/01/2008 16:00")

    ' Set Locaiton properties
    .LocationName = "Coal Dock #1"

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

    ' Set LineBoat properties
    .LineBoatName = "Billy G."

    ' For the available EstimatedCost properties
    With .EstimatedCost

        ' Set the rate type to FixedRate
        .RateType = BargeEx.CicaRateType.FixedRate

        ' Set the rate information properties
        .FixedRateAmount = 200

        ' Add incidentals
        .Incidentals.Add(New BargeEx.Incidental(BargeEx.CicaIncidentalCode.Fuel, 100, 2))
        .Incidentals.Add(New BargeEx.Incidental(BargeEx.CicaIncidentalCode.HighWater, 50))

    End With ' .EstimatedCost


End With ' BargeStatus

CopyC#

// Create a new BargeEx BargeStatus object
BargeEx.BargeStatus BargeStatus = new BargeEx.BargeStatus();

// Update the BargeStatus properties before
// returning the object to the user

// Update the DocumentHeader property
BargeStatus.Header.SenderTradingPartnerNumber = "12345678";
BargeStatus.Header.ReceiverTradingPartnerNumber = "87654321";
BargeStatus.Header.InstanceIdentifier = "ABC123";
BargeStatus.Header.CreateDateTime = DateTime.Parse("01/01/2008 16:00");

// Set the ApplicationHeader properties
BargeStatus.CreateDateTime = DateTime.Parse("01/01/2008 16:00");
BargeStatus.TransactionIdentifier = "ABC123";
BargeStatus.PurposeCode = BargeEx.CicaTransactionPurposeCode.NewTransaction;
BargeStatus.Note = "BargeStatus test note.";
BargeStatus.ResponsibleLocationName = "Fleeter ABC";

// Set the document's Event Information section
BargeStatus.BargeName = "CSG123";

// Set the EventStatusType to Assist
BargeStatus.EventStatusType = BargeEx.CicaBargeEventStatusType.Assist;

// Set the start and end date times
BargeStatus.StartDateTime = DateTime.Parse("01/01/2008 16:00");
BargeStatus.EndDateTime = DateTime.Parse("01/01/2008 16:00");

// Set Locaiton properties
BargeStatus.LocationName = "Coal Dock #1";

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

// Set LineBoat properties
BargeStatus.LineBoatName = "Billy G.";

// For the available EstimatedCost properties

// Set the rate type to FixedRate
BargeStatus.EstimatedCost.RateType = BargeEx.CicaRateType.FixedRate;

// Set the rate information properties
BargeStatus.EstimatedCost.FixedRateAmount = 200;

// Add incidentals
BargeStatus.EstimatedCost.Incidentals.Add(
   new BargeEx.Incidental(BargeEx.CicaIncidentalCode.Fuel, 100, 2));
BargeStatus.EstimatedCost.Incidentals.Add(
   new BargeEx.Incidental(BargeEx.CicaIncidentalCode.HighWater, 50));

System..::.Object
  BargeEx.Internal..::.SerializableBase
    BargeEx.Internal..::.DocumentBase
      BargeEx.Internal..::.BargeExDocumentBase
        BargeEx.Internal..::.UpdatableBargeExDocumentBase
          BargeEx..::.BargeStatus