The IForwardingInstructions type exposes the following members.

Methods

  NameDescription
Public methodAddDescription
Add a new 'Description' entry. Description (BBIE). Description of the type of Forwarding Instructions.
Public methodAddDocumentRef
Add a new 'Document Reference' entry. Document Reference (ASBIE). An association to Document Reference.
Public methodAddExchangeRate
Add a new 'Exchange Rate' entry. Exchange Rate (ASBIE). Information that directly relates to the rate of exchange (conversion) between two currencies.
Public methodAddNote
Add a new 'Note' entry. Note (BBIE). Informative notes associated with the Forwarding Instructions.
Public methodAddOtherInstruction
Add a new 'Instruction' entry. Instruction (BBIE). Contains other free-text based instructions related to the shipment to the forwarders or carriers. This should only be used where such information cannot be represented in other structured information entities within the document.
Public methodAddSignature
Add a new 'Signature' entry. Signature (ASBIE). One or more signatures applied to the document instance.
Public methodAssignStyleSheet
Assigns a XSLT stylesheet to the document.
Public methodClearDescriptions
Removes all 'Description' entries. Description (BBIE). Description of the type of Forwarding Instructions.
Public methodClearDocumentRefs
Removes all 'Document Reference' entries. Document Reference (ASBIE). An association to Document Reference.
Public methodClearExchangeRates
Removes all 'Exchange Rate' entries. Exchange Rate (ASBIE). Information that directly relates to the rate of exchange (conversion) between two currencies.
Public methodClearNotes
Removes all 'Note' entries. Note (BBIE). Informative notes associated with the Forwarding Instructions.
Public methodClearOtherInstructions
Removes all 'Instruction' entries. Instruction (BBIE). Contains other free-text based instructions related to the shipment to the forwarders or carriers. This should only be used where such information cannot be represented in other structured information entities within the document.
Public methodClearSignatures
Removes all 'Signature' entries. Signature (ASBIE). One or more signatures applied to the document instance.
Public methodGetDescription
Gets a 'Description' entry. Description (BBIE). Description of the type of Forwarding Instructions.
Public methodGetDescriptionCount
Gets the number of 'Description' entries in the container object. Description (BBIE). Description of the type of Forwarding Instructions.
Public methodGetDocumentAsBinary
Gets the document as binary data (UTF-8 encoded).
Public methodGetDocumentAsText
Gets the document as a string (UTF-8 encoded).
Public methodGetDocumentRef
Gets a 'Document Reference' entry. Document Reference (ASBIE). An association to Document Reference.
Public methodGetDocumentRefCount
Gets the number of 'Document Reference' entries in the container object. Document Reference (ASBIE). An association to Document Reference.
Public methodGetExchangeRate
Gets a 'Exchange Rate' entry. Exchange Rate (ASBIE). Information that directly relates to the rate of exchange (conversion) between two currencies.
Public methodGetExchangeRateCount
Gets the number of 'Exchange Rate' entries in the container object. Exchange Rate (ASBIE). Information that directly relates to the rate of exchange (conversion) between two currencies.
Public methodGetNote
Gets a 'Note' entry. Note (BBIE). Informative notes associated with the Forwarding Instructions.
Public methodGetNoteCount
Gets the number of 'Note' entries in the container object. Note (BBIE). Informative notes associated with the Forwarding Instructions.
Public methodGetOtherInstruction
Gets a 'Instruction' entry. Instruction (BBIE). Contains other free-text based instructions related to the shipment to the forwarders or carriers. This should only be used where such information cannot be represented in other structured information entities within the document.
Public methodGetOtherInstructionCount
Gets the number of 'Instruction' entries in the container object. Instruction (BBIE). Contains other free-text based instructions related to the shipment to the forwarders or carriers. This should only be used where such information cannot be represented in other structured information entities within the document.
Public methodGetSignature
Gets a 'Signature' entry. Signature (ASBIE). One or more signatures applied to the document instance.
Public methodGetSignatureCount
Gets the number of 'Signature' entries in the container object. Signature (ASBIE). One or more signatures applied to the document instance.
Public methodRead
Reads the document from file.
Public methodRemoveDescription
Removes a 'Description' entry. Description (BBIE). Description of the type of Forwarding Instructions.
Public methodRemoveDocumentRef
Removes a 'Document Reference' entry. Document Reference (ASBIE). An association to Document Reference.
Public methodRemoveExchangeRate
Removes a 'Exchange Rate' entry. Exchange Rate (ASBIE). Information that directly relates to the rate of exchange (conversion) between two currencies.
Public methodRemoveNote
Removes a 'Note' entry. Note (BBIE). Informative notes associated with the Forwarding Instructions.
Public methodRemoveOtherInstruction
Removes a 'Instruction' entry. Instruction (BBIE). Contains other free-text based instructions related to the shipment to the forwarders or carriers. This should only be used where such information cannot be represented in other structured information entities within the document.
Public methodRemoveSignature
Removes a 'Signature' entry. Signature (ASBIE). One or more signatures applied to the document instance.
Public methodResetAdValoremIndicator
Resets the node.
Public methodResetCarrierAssignedID
Resets the node.
Public methodResetCarrierParty
Resets the node.
Public methodResetConsignorParty
Resets the node.
Public methodResetCustomizationID
Resets the node.
Public methodResetDeclaredCarriageValueAmount
Resets the node.
Public methodResetDocumentStatusCode
Resets the node.
Public methodResetFreightForwarderParty
Resets the node.
Public methodResetID
Resets the node.
Public methodResetName
Resets the node.
Public methodResetProfileID
Resets the node.
Public methodResetShipment
Resets the node.
Public methodResetShippingOrderID
Resets the node.
Public methodResetToOrderIndicator
Resets the node.
Public methodResetUBLExtensions
Resets the node.
Public methodResetUBLVersionID
Resets the node.
Public methodResetUUID
Resets the node.
Public methodSetDocument
Sets the document from an object. The object can be a string or a binary array.
Public methodSetOutputEncoding
Sets the desired output encoding. An empty string resets it to its default (normally UTF-8).
Public methodWrite
Writes the document to file.

Properties

  NameDescription
Public propertyAdValoremIndicator
Indicator (BBIE). A term used in commerce in reference to certain duties, called ad valorem duties, which are levied on commodities at certain rates per centum on their value.
Public propertyAdValoremIndicatorSet
Checks if the property has been set or not.
Public propertyCarrierAssignedID
Identifier (BBIE). Reference number assigned by a carrier or its agent to identify a specific shipment such as a booking reference number when cargo space is reserved prior to loading.
Public propertyCarrierAssignedIDSet
Checks if the property has been set or not.
Public propertyCarrierParty
Party (ASBIE). The party providing the transport of goods between named points.
Public propertyCarrierPartySet
Checks if the property has been set or not.
Public propertyConsignorParty
Party (ASBIE). The party consigning goods, as stipulated in the transport contract by the party ordering transport.
Public propertyConsignorPartySet
Checks if the property has been set or not.
Public propertyCustomizationID
Customization Identifier (BBIE). Identifies a user-defined Customization of UBL for a specific use.
Public propertyCustomizationIDSet
Checks if the property has been set or not.
Public propertyDeclaredCarriageValueAmount
Value (BBIE). Value, declared by the shipper or his agent solely for the purpose of varying the carrier's level of liability from that provided in the contract of carriage, in case of loss or damage to goods or delayed delivery.
Public propertyDeclaredCarriageValueAmountSet
Checks if the property has been set or not.
Public propertyDocumentStatusCode
Document Status Code (BBIE). Identifies the status of the Forwarding Instructions with respect to its original state. This may be used if the document precedes the event and is subsequently found to be incorrect and in need of cancelling or revising.
Public propertyDocumentStatusCodeSet
Checks if the property has been set or not.
Public propertyFreightForwarderParty
Party (ASBIE). The party combining individual smaller consignments into a single larger consignment (so-called consolidated consignment) that is sent to a counterpart who mirrors the consolidator's activity by dividing the consolidated consignment into its original components.
Public propertyFreightForwarderPartySet
Checks if the property has been set or not.
Public propertyID
Identifier (BBIE). Unique identifier of the Forwarding Instructions. Reference number to identify a Shipping Instruction.
Public propertyIDSet
Checks if the property has been set or not.
Public propertyIssueDate
Issue Date (BBIE). Date on which the Forwarding Instructions were issued.
Public propertyIssueTime
Issue Time (BBIE). Time at which the Forwarding Instructions were issued.
Public propertyName
Name (BBIE). Name of a Forwarding Instructions.
Public propertyNameSet
Checks if the property has been set or not.
Public propertyNamespaceUri
Gets the namespace URI of this document.
Public propertyProfileID
Profile Identifier (BBIE). Identifies a user-defined profile of the customization of UBL being used.
Public propertyProfileIDSet
Checks if the property has been set or not.
Public propertyShipment
Shipment (ASBIE). Information about the separately identifiable collection of goods items (available to be) transported from one consignor to one consignee via one or more modes of transport.
Public propertyShipmentSet
Checks if the property has been set or not.
Public propertyShippingOrderID
Shipping Order Identifier (BBIE). Reference number to identify a Shipping Order.
Public propertyShippingOrderIDSet
Checks if the property has been set or not.
Public propertyToOrderIndicator
Indicator (BBIE). Indicator of whether the transport document is consigned to order.
Public propertyToOrderIndicatorSet
Checks if the property has been set or not.
Public propertyUBLExtensions
().
Public propertyUBLExtensionsSet
Checks if the property has been set or not.
Public propertyUBLVersionID
UBL Version Identifier (BBIE). The earliest version of the UBL 2 schema for this document type that defines all of the elements that might be encountered in the current instance.
Public propertyUBLVersionIDSet
Checks if the property has been set or not.
Public propertyUUID
UUID (BBIE). A universally unique identifier for an instance of this ABIE.
Public propertyUUIDSet
Checks if the property has been set or not.

See Also