ForwardingInstructionsType (Difi Commons :: Universal Business Language (UBL) 2.1 0.9.5 API)

java.lang.Object
- no.difi.commons.ubl21.jaxb.ForwardingInstructionsType

public class ForwardingInstructionsType
extends Object

Java class for ForwardingInstructionsType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ForwardingInstructionsType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonExtensionComponents-2}UBLExtensions" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}UBLVersionID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}CustomizationID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ProfileID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ProfileExecutionID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ID"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}CarrierAssignedID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}UUID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}IssueDate" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}IssueTime" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Name" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Description" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Note" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}DocumentStatusCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ShippingOrderID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ToOrderIndicator" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}AdValoremIndicator" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}DeclaredCarriageValueAmount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}OtherInstruction" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ConsignorParty" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}CarrierParty" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}FreightForwarderParty" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Shipment"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}DocumentReference" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}ExchangeRate" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}Signature" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected AdValoremIndicatorType`	`adValoremIndicator`
`protected CarrierAssignedIDType`	`carrierAssignedID`
`protected PartyType`	`carrierParty`
`protected PartyType`	`consignorParty`
`protected CustomizationIDType`	`customizationID`
`protected DeclaredCarriageValueAmountType`	`declaredCarriageValueAmount`
`protected List<DescriptionType>`	`description`
`protected List<DocumentReferenceType>`	`documentReference`
`protected DocumentStatusCodeType`	`documentStatusCode`
`protected List<ExchangeRateType>`	`exchangeRate`
`protected PartyType`	`freightForwarderParty`
`protected IDType`	`id`
`protected IssueDateType`	`issueDate`
`protected IssueTimeType`	`issueTime`
`protected NameType`	`name`
`protected List<NoteType>`	`note`
`protected List<OtherInstructionType>`	`otherInstruction`
`protected ProfileExecutionIDType`	`profileExecutionID`
`protected ProfileIDType`	`profileID`
`protected ShipmentType`	`shipment`
`protected ShippingOrderIDType`	`shippingOrderID`
`protected List<SignatureType>`	`signature`
`protected ToOrderIndicatorType`	`toOrderIndicator`
`protected UBLExtensionsType`	`ublExtensions`
`protected UBLVersionIDType`	`ublVersionID`
`protected UUIDType`	`uuid`

Constructor Summary

Constructors
Constructor and Description

ForwardingInstructionsType()

Constructors
Constructor and Description
`ForwardingInstructionsType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdValoremIndicatorType`	`getAdValoremIndicator()` Gets the value of the adValoremIndicator property.
`CarrierAssignedIDType`	`getCarrierAssignedID()` Gets the value of the carrierAssignedID property.
`PartyType`	`getCarrierParty()` Gets the value of the carrierParty property.
`PartyType`	`getConsignorParty()` Gets the value of the consignorParty property.
`CustomizationIDType`	`getCustomizationID()` Gets the value of the customizationID property.
`DeclaredCarriageValueAmountType`	`getDeclaredCarriageValueAmount()` Gets the value of the declaredCarriageValueAmount property.
`List<DescriptionType>`	`getDescription()` Gets the value of the description property.
`List<DocumentReferenceType>`	`getDocumentReference()` Gets the value of the documentReference property.
`DocumentStatusCodeType`	`getDocumentStatusCode()` Gets the value of the documentStatusCode property.
`List<ExchangeRateType>`	`getExchangeRate()` Gets the value of the exchangeRate property.
`PartyType`	`getFreightForwarderParty()` Gets the value of the freightForwarderParty property.
`IDType`	`getID()` Gets the value of the id property.
`IssueDateType`	`getIssueDate()` Gets the value of the issueDate property.
`IssueTimeType`	`getIssueTime()` Gets the value of the issueTime property.
`NameType`	`getName()` Gets the value of the name property.
`List<NoteType>`	`getNote()` Gets the value of the note property.
`List<OtherInstructionType>`	`getOtherInstruction()` Gets the value of the otherInstruction property.
`ProfileExecutionIDType`	`getProfileExecutionID()` Gets the value of the profileExecutionID property.
`ProfileIDType`	`getProfileID()` Gets the value of the profileID property.
`ShipmentType`	`getShipment()` Gets the value of the shipment property.
`ShippingOrderIDType`	`getShippingOrderID()` Gets the value of the shippingOrderID property.
`List<SignatureType>`	`getSignature()` Gets the value of the signature property.
`ToOrderIndicatorType`	`getToOrderIndicator()` Gets the value of the toOrderIndicator property.
`UBLExtensionsType`	`getUBLExtensions()` Gets the value of the ublExtensions property.
`UBLVersionIDType`	`getUBLVersionID()` Gets the value of the ublVersionID property.
`UUIDType`	`getUUID()` Gets the value of the uuid property.
`void`	`setAdValoremIndicator(AdValoremIndicatorType value)` Sets the value of the adValoremIndicator property.
`void`	`setCarrierAssignedID(CarrierAssignedIDType value)` Sets the value of the carrierAssignedID property.
`void`	`setCarrierParty(PartyType value)` Sets the value of the carrierParty property.
`void`	`setConsignorParty(PartyType value)` Sets the value of the consignorParty property.
`void`	`setCustomizationID(CustomizationIDType value)` Sets the value of the customizationID property.
`void`	`setDeclaredCarriageValueAmount(DeclaredCarriageValueAmountType value)` Sets the value of the declaredCarriageValueAmount property.
`void`	`setDocumentStatusCode(DocumentStatusCodeType value)` Sets the value of the documentStatusCode property.
`void`	`setFreightForwarderParty(PartyType value)` Sets the value of the freightForwarderParty property.
`void`	`setID(IDType value)` Sets the value of the id property.
`void`	`setIssueDate(IssueDateType value)` Sets the value of the issueDate property.
`void`	`setIssueTime(IssueTimeType value)` Sets the value of the issueTime property.
`void`	`setName(NameType value)` Sets the value of the name property.
`void`	`setProfileExecutionID(ProfileExecutionIDType value)` Sets the value of the profileExecutionID property.
`void`	`setProfileID(ProfileIDType value)` Sets the value of the profileID property.
`void`	`setShipment(ShipmentType value)` Sets the value of the shipment property.
`void`	`setShippingOrderID(ShippingOrderIDType value)` Sets the value of the shippingOrderID property.
`void`	`setToOrderIndicator(ToOrderIndicatorType value)` Sets the value of the toOrderIndicator property.
`void`	`setUBLExtensions(UBLExtensionsType value)` Sets the value of the ublExtensions property.
`void`	`setUBLVersionID(UBLVersionIDType value)` Sets the value of the ublVersionID property.
`void`	`setUUID(UUIDType value)` Sets the value of the uuid property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ublExtensions
```
protected UBLExtensionsType ublExtensions
```
  - ublVersionID
```
protected UBLVersionIDType ublVersionID
```
  - customizationID
```
protected CustomizationIDType customizationID
```
  - profileID
```
protected ProfileIDType profileID
```
  - profileExecutionID
```
protected ProfileExecutionIDType profileExecutionID
```
  - id
```
protected IDType id
```
  - carrierAssignedID
```
protected CarrierAssignedIDType carrierAssignedID
```
  - uuid
```
protected UUIDType uuid
```
  - issueDate
```
protected IssueDateType issueDate
```
  - issueTime
```
protected IssueTimeType issueTime
```
  - name
```
protected NameType name
```
  - description
```
protected List<DescriptionType> description
```
  - note
```
protected List<NoteType> note
```
  - documentStatusCode
```
protected DocumentStatusCodeType documentStatusCode
```
  - shippingOrderID
```
protected ShippingOrderIDType shippingOrderID
```
  - toOrderIndicator
```
protected ToOrderIndicatorType toOrderIndicator
```
  - adValoremIndicator
```
protected AdValoremIndicatorType adValoremIndicator
```
  - declaredCarriageValueAmount
```
protected DeclaredCarriageValueAmountType declaredCarriageValueAmount
```
  - otherInstruction
```
protected List<OtherInstructionType> otherInstruction
```
  - consignorParty
```
protected PartyType consignorParty
```
  - carrierParty
```
protected PartyType carrierParty
```
  - freightForwarderParty
```
protected PartyType freightForwarderParty
```
  - shipment
```
protected ShipmentType shipment
```
  - documentReference
```
protected List<DocumentReferenceType> documentReference
```
  - exchangeRate
```
protected List<ExchangeRateType> exchangeRate
```
  - signature
```
protected List<SignatureType> signature
```
- Constructor Detail
  - ForwardingInstructionsType
```
public ForwardingInstructionsType()
```
- Method Detail
  - getUBLExtensions
```
public UBLExtensionsType getUBLExtensions()
```
    Gets the value of the ublExtensions property.
    
    Returns:
    
    possible object is UBLExtensionsType
  - setUBLExtensions
```
public void setUBLExtensions(UBLExtensionsType value)
```
    Sets the value of the ublExtensions property.
    
    Parameters:
    
    value - allowed object is UBLExtensionsType
  - getUBLVersionID
```
public UBLVersionIDType getUBLVersionID()
```
    Gets the value of the ublVersionID property.
    
    Returns:
    
    possible object is UBLVersionIDType
  - setUBLVersionID
```
public void setUBLVersionID(UBLVersionIDType value)
```
    Sets the value of the ublVersionID property.
    
    Parameters:
    
    value - allowed object is UBLVersionIDType
  - getCustomizationID
```
public CustomizationIDType getCustomizationID()
```
    Gets the value of the customizationID property.
    
    Returns:
    
    possible object is CustomizationIDType
  - setCustomizationID
```
public void setCustomizationID(CustomizationIDType value)
```
    Sets the value of the customizationID property.
    
    Parameters:
    
    value - allowed object is CustomizationIDType
  - getProfileID
```
public ProfileIDType getProfileID()
```
    Gets the value of the profileID property.
    
    Returns:
    
    possible object is ProfileIDType
  - setProfileID
```
public void setProfileID(ProfileIDType value)
```
    Sets the value of the profileID property.
    
    Parameters:
    
    value - allowed object is ProfileIDType
  - getProfileExecutionID
```
public ProfileExecutionIDType getProfileExecutionID()
```
    Gets the value of the profileExecutionID property.
    
    Returns:
    
    possible object is ProfileExecutionIDType
  - setProfileExecutionID
```
public void setProfileExecutionID(ProfileExecutionIDType value)
```
    Sets the value of the profileExecutionID property.
    
    Parameters:
    
    value - allowed object is ProfileExecutionIDType
  - getID
```
public IDType getID()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is IDType
  - setID
```
public void setID(IDType value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is IDType
  - getCarrierAssignedID
```
public CarrierAssignedIDType getCarrierAssignedID()
```
    Gets the value of the carrierAssignedID property.
    
    Returns:
    
    possible object is CarrierAssignedIDType
  - setCarrierAssignedID
```
public void setCarrierAssignedID(CarrierAssignedIDType value)
```
    Sets the value of the carrierAssignedID property.
    
    Parameters:
    
    value - allowed object is CarrierAssignedIDType
  - getUUID
```
public UUIDType getUUID()
```
    Gets the value of the uuid property.
    
    Returns:
    
    possible object is UUIDType
  - setUUID
```
public void setUUID(UUIDType value)
```
    Sets the value of the uuid property.
    
    Parameters:
    
    value - allowed object is UUIDType
  - getIssueDate
```
public IssueDateType getIssueDate()
```
    Gets the value of the issueDate property.
    
    Returns:
    
    possible object is IssueDateType
  - setIssueDate
```
public void setIssueDate(IssueDateType value)
```
    Sets the value of the issueDate property.
    
    Parameters:
    
    value - allowed object is IssueDateType
  - getIssueTime
```
public IssueTimeType getIssueTime()
```
    Gets the value of the issueTime property.
    
    Returns:
    
    possible object is IssueTimeType
  - setIssueTime
```
public void setIssueTime(IssueTimeType value)
```
    Sets the value of the issueTime property.
    
    Parameters:
    
    value - allowed object is IssueTimeType
  - getName
```
public NameType getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is NameType
  - setName
```
public void setName(NameType value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is NameType
  - getDescription
```
public List<DescriptionType> getDescription()
```
    Gets the value of the description property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the description property.
    For example, to add a new item, do as follows:
```
    getDescription().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list DescriptionType
  - getNote
```
public List<NoteType> getNote()
```
    Gets the value of the note property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the note property.
    For example, to add a new item, do as follows:
```
    getNote().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list NoteType
  - getDocumentStatusCode
```
public DocumentStatusCodeType getDocumentStatusCode()
```
    Gets the value of the documentStatusCode property.
    
    Returns:
    
    possible object is DocumentStatusCodeType
  - setDocumentStatusCode
```
public void setDocumentStatusCode(DocumentStatusCodeType value)
```
    Sets the value of the documentStatusCode property.
    
    Parameters:
    
    value - allowed object is DocumentStatusCodeType
  - getShippingOrderID
```
public ShippingOrderIDType getShippingOrderID()
```
    Gets the value of the shippingOrderID property.
    
    Returns:
    
    possible object is ShippingOrderIDType
  - setShippingOrderID
```
public void setShippingOrderID(ShippingOrderIDType value)
```
    Sets the value of the shippingOrderID property.
    
    Parameters:
    
    value - allowed object is ShippingOrderIDType
  - getToOrderIndicator
```
public ToOrderIndicatorType getToOrderIndicator()
```
    Gets the value of the toOrderIndicator property.
    
    Returns:
    
    possible object is ToOrderIndicatorType
  - setToOrderIndicator
```
public void setToOrderIndicator(ToOrderIndicatorType value)
```
    Sets the value of the toOrderIndicator property.
    
    Parameters:
    
    value - allowed object is ToOrderIndicatorType
  - getAdValoremIndicator
```
public AdValoremIndicatorType getAdValoremIndicator()
```
    Gets the value of the adValoremIndicator property.
    
    Returns:
    
    possible object is AdValoremIndicatorType
  - setAdValoremIndicator
```
public void setAdValoremIndicator(AdValoremIndicatorType value)
```
    Sets the value of the adValoremIndicator property.
    
    Parameters:
    
    value - allowed object is AdValoremIndicatorType
  - getDeclaredCarriageValueAmount
```
public DeclaredCarriageValueAmountType getDeclaredCarriageValueAmount()
```
    Gets the value of the declaredCarriageValueAmount property.
    
    Returns:
    
    possible object is DeclaredCarriageValueAmountType
  - setDeclaredCarriageValueAmount
```
public void setDeclaredCarriageValueAmount(DeclaredCarriageValueAmountType value)
```
    Sets the value of the declaredCarriageValueAmount property.
    
    Parameters:
    
    value - allowed object is DeclaredCarriageValueAmountType
  - getOtherInstruction
```
public List<OtherInstructionType> getOtherInstruction()
```
    Gets the value of the otherInstruction property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the otherInstruction property.
    For example, to add a new item, do as follows:
```
    getOtherInstruction().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list OtherInstructionType
  - getConsignorParty
```
public PartyType getConsignorParty()
```
    Gets the value of the consignorParty property.
    
    Returns:
    
    possible object is PartyType
  - setConsignorParty
```
public void setConsignorParty(PartyType value)
```
    Sets the value of the consignorParty property.
    
    Parameters:
    
    value - allowed object is PartyType
  - getCarrierParty
```
public PartyType getCarrierParty()
```
    Gets the value of the carrierParty property.
    
    Returns:
    
    possible object is PartyType
  - setCarrierParty
```
public void setCarrierParty(PartyType value)
```
    Sets the value of the carrierParty property.
    
    Parameters:
    
    value - allowed object is PartyType
  - getFreightForwarderParty
```
public PartyType getFreightForwarderParty()
```
    Gets the value of the freightForwarderParty property.
    
    Returns:
    
    possible object is PartyType
  - setFreightForwarderParty
```
public void setFreightForwarderParty(PartyType value)
```
    Sets the value of the freightForwarderParty property.
    
    Parameters:
    
    value - allowed object is PartyType
  - getShipment
```
public ShipmentType getShipment()
```
    Gets the value of the shipment property.
    
    Returns:
    
    possible object is ShipmentType
  - setShipment
```
public void setShipment(ShipmentType value)
```
    Sets the value of the shipment property.
    
    Parameters:
    
    value - allowed object is ShipmentType
  - getDocumentReference
```
public List<DocumentReferenceType> getDocumentReference()
```
    Gets the value of the documentReference property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the documentReference property.
    For example, to add a new item, do as follows:
```
    getDocumentReference().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list DocumentReferenceType
  - getExchangeRate
```
public List<ExchangeRateType> getExchangeRate()
```
    Gets the value of the exchangeRate property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the exchangeRate property.
    For example, to add a new item, do as follows:
```
    getExchangeRate().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ExchangeRateType
  - getSignature
```
public List<SignatureType> getSignature()
```
    Gets the value of the signature property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the signature property.
    For example, to add a new item, do as follows:
```
    getSignature().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list SignatureType

Class ForwardingInstructionsType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ublExtensions

ublVersionID

customizationID

profileID

profileExecutionID

id

carrierAssignedID

uuid

issueDate

issueTime

name

description

note

documentStatusCode

shippingOrderID

toOrderIndicator

adValoremIndicator

declaredCarriageValueAmount

otherInstruction

consignorParty

carrierParty

freightForwarderParty

shipment

documentReference

exchangeRate

signature

Constructor Detail

ForwardingInstructionsType

Method Detail

getUBLExtensions

setUBLExtensions

getUBLVersionID

setUBLVersionID

getCustomizationID

setCustomizationID

getProfileID

setProfileID

getProfileExecutionID

setProfileExecutionID

getID

setID

getCarrierAssignedID

setCarrierAssignedID

getUUID

setUUID

getIssueDate

setIssueDate

getIssueTime

setIssueTime

getName

setName

getDescription

getNote

getDocumentStatusCode

setDocumentStatusCode

getShippingOrderID

setShippingOrderID

getToOrderIndicator

setToOrderIndicator

getAdValoremIndicator

setAdValoremIndicator

getDeclaredCarriageValueAmount

setDeclaredCarriageValueAmount

getOtherInstruction

getConsignorParty

setConsignorParty

getCarrierParty

setCarrierParty

getFreightForwarderParty

setFreightForwarderParty

getShipment

setShipment

getDocumentReference

getExchangeRate