The IForwardingInstructions type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| AddDescription |
Add a new 'Description' entry.
Description (BBIE). Description of the type of Forwarding Instructions.
| |
| AddDocumentRef |
Add a new 'Document Reference' entry.
Document Reference (ASBIE). An association to Document Reference.
| |
| AddExchangeRate |
Add a new 'Exchange Rate' entry.
Exchange Rate (ASBIE). Information that directly relates to the rate of exchange (conversion) between two currencies.
| |
| AddNote |
Add a new 'Note' entry.
Note (BBIE). Informative notes associated with the Forwarding Instructions.
| |
| AddOtherInstruction |
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.
| |
| AddSignature |
Add a new 'Signature' entry.
Signature (ASBIE). One or more signatures applied to the document instance.
| |
| AssignStyleSheet |
Assigns a XSLT stylesheet to the document.
| |
| ClearDescriptions |
Removes all 'Description' entries.
Description (BBIE). Description of the type of Forwarding Instructions.
| |
| ClearDocumentRefs |
Removes all 'Document Reference' entries.
Document Reference (ASBIE). An association to Document Reference.
| |
| ClearExchangeRates |
Removes all 'Exchange Rate' entries.
Exchange Rate (ASBIE). Information that directly relates to the rate of exchange (conversion) between two currencies.
| |
| ClearNotes |
Removes all 'Note' entries.
Note (BBIE). Informative notes associated with the Forwarding Instructions.
| |
| ClearOtherInstructions |
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.
| |
| ClearSignatures |
Removes all 'Signature' entries.
Signature (ASBIE). One or more signatures applied to the document instance.
| |
| GetDescription |
Gets a 'Description' entry.
Description (BBIE). Description of the type of Forwarding Instructions.
| |
| GetDescriptionCount |
Gets the number of 'Description' entries in the container object.
Description (BBIE). Description of the type of Forwarding Instructions.
| |
| GetDocumentAsBinary |
Gets the document as binary data (UTF-8 encoded).
| |
| GetDocumentAsText |
Gets the document as a string (UTF-8 encoded).
| |
| GetDocumentRef |
Gets a 'Document Reference' entry.
Document Reference (ASBIE). An association to Document Reference.
| |
| GetDocumentRefCount |
Gets the number of 'Document Reference' entries in the container object.
Document Reference (ASBIE). An association to Document Reference.
| |
| GetExchangeRate |
Gets a 'Exchange Rate' entry.
Exchange Rate (ASBIE). Information that directly relates to the rate of exchange (conversion) between two currencies.
| |
| GetExchangeRateCount |
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.
| |
| GetNote |
Gets a 'Note' entry.
Note (BBIE). Informative notes associated with the Forwarding Instructions.
| |
| GetNoteCount |
Gets the number of 'Note' entries in the container object.
Note (BBIE). Informative notes associated with the Forwarding Instructions.
| |
| GetOtherInstruction |
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.
| |
| GetOtherInstructionCount |
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.
| |
| GetSignature |
Gets a 'Signature' entry.
Signature (ASBIE). One or more signatures applied to the document instance.
| |
| GetSignatureCount |
Gets the number of 'Signature' entries in the container object.
Signature (ASBIE). One or more signatures applied to the document instance.
| |
| Read |
Reads the document from file.
| |
| RemoveDescription |
Removes a 'Description' entry.
Description (BBIE). Description of the type of Forwarding Instructions.
| |
| RemoveDocumentRef |
Removes a 'Document Reference' entry.
Document Reference (ASBIE). An association to Document Reference.
| |
| RemoveExchangeRate |
Removes a 'Exchange Rate' entry.
Exchange Rate (ASBIE). Information that directly relates to the rate of exchange (conversion) between two currencies.
| |
| RemoveNote |
Removes a 'Note' entry.
Note (BBIE). Informative notes associated with the Forwarding Instructions.
| |
| RemoveOtherInstruction |
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.
| |
| RemoveSignature |
Removes a 'Signature' entry.
Signature (ASBIE). One or more signatures applied to the document instance.
| |
| ResetAdValoremIndicator |
Resets the node.
| |
| ResetCarrierAssignedID |
Resets the node.
| |
| ResetCarrierParty |
Resets the node.
| |
| ResetConsignorParty |
Resets the node.
| |
| ResetCustomizationID |
Resets the node.
| |
| ResetDeclaredCarriageValueAmount |
Resets the node.
| |
| ResetDocumentStatusCode |
Resets the node.
| |
| ResetFreightForwarderParty |
Resets the node.
| |
| ResetID |
Resets the node.
| |
| ResetName |
Resets the node.
| |
| ResetProfileID |
Resets the node.
| |
| ResetShipment |
Resets the node.
| |
| ResetShippingOrderID |
Resets the node.
| |
| ResetToOrderIndicator |
Resets the node.
| |
| ResetUBLExtensions |
Resets the node.
| |
| ResetUBLVersionID |
Resets the node.
| |
| ResetUUID |
Resets the node.
| |
| SetDocument |
Sets the document from an object. The object can be a string or
a binary array.
| |
| SetOutputEncoding |
Sets the desired output encoding. An empty string resets it to its default (normally UTF-8).
| |
| Write |
Writes the document to file.
|
Properties
| Name | Description | |
|---|---|---|
| AdValoremIndicator |
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.
| |
| AdValoremIndicatorSet |
Checks if the property has been set or not.
| |
| CarrierAssignedID |
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.
| |
| CarrierAssignedIDSet |
Checks if the property has been set or not.
| |
| CarrierParty |
Party (ASBIE). The party providing the transport of goods between named points.
| |
| CarrierPartySet |
Checks if the property has been set or not.
| |
| ConsignorParty |
Party (ASBIE). The party consigning goods, as stipulated in the transport contract by the party ordering transport.
| |
| ConsignorPartySet |
Checks if the property has been set or not.
| |
| CustomizationID |
Customization Identifier (BBIE). Identifies a user-defined Customization of UBL for a specific use.
| |
| CustomizationIDSet |
Checks if the property has been set or not.
| |
| DeclaredCarriageValueAmount |
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.
| |
| DeclaredCarriageValueAmountSet |
Checks if the property has been set or not.
| |
| DocumentStatusCode |
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.
| |
| DocumentStatusCodeSet |
Checks if the property has been set or not.
| |
| FreightForwarderParty |
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.
| |
| FreightForwarderPartySet |
Checks if the property has been set or not.
| |
| ID |
Identifier (BBIE). Unique identifier of the Forwarding Instructions. Reference number to identify a Shipping Instruction.
| |
| IDSet |
Checks if the property has been set or not.
| |
| IssueDate |
Issue Date (BBIE). Date on which the Forwarding Instructions were issued.
| |
| IssueTime |
Issue Time (BBIE). Time at which the Forwarding Instructions were issued.
| |
| Name |
Name (BBIE). Name of a Forwarding Instructions.
| |
| NameSet |
Checks if the property has been set or not.
| |
| NamespaceUri |
Gets the namespace URI of this document.
| |
| ProfileID |
Profile Identifier (BBIE). Identifies a user-defined profile of the customization of UBL being used.
| |
| ProfileIDSet |
Checks if the property has been set or not.
| |
| Shipment |
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.
| |
| ShipmentSet |
Checks if the property has been set or not.
| |
| ShippingOrderID |
Shipping Order Identifier (BBIE). Reference number to identify a Shipping Order.
| |
| ShippingOrderIDSet |
Checks if the property has been set or not.
| |
| ToOrderIndicator |
Indicator (BBIE). Indicator of whether the transport document is consigned to order.
| |
| ToOrderIndicatorSet |
Checks if the property has been set or not.
| |
| UBLExtensions |
().
| |
| UBLExtensionsSet |
Checks if the property has been set or not.
| |
| UBLVersionID |
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.
| |
| UBLVersionIDSet |
Checks if the property has been set or not.
| |
| UUID |
UUID (BBIE). A universally unique identifier for an instance of this ABIE.
| |
| UUIDSet |
Checks if the property has been set or not.
|