VmsMessage (DATEX II Java API 0.1 API)

java.lang.Object
- eu.datex2.schema._2._2_0.VmsMessage

public class VmsMessage
extends Object

Java class for VmsMessage complex type.

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

 <complexType name="VmsMessage">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="associatedManagementOrDiversionPlan" type="{http://datex2.eu/schema/2/2_0}String" minOccurs="0"/>
         <element name="messageSetBy" type="{http://datex2.eu/schema/2/2_0}MultilingualString" minOccurs="0"/>
         <element name="setBySystem" type="{http://datex2.eu/schema/2/2_0}Boolean" minOccurs="0"/>
         <element name="reasonForSetting" type="{http://datex2.eu/schema/2/2_0}MultilingualString" minOccurs="0"/>
         <element name="codedReasonForSetting" type="{http://datex2.eu/schema/2/2_0}CodedReasonForSettingMessageEnum" minOccurs="0"/>
         <element name="vmsMessageInformationType" type="{http://datex2.eu/schema/2/2_0}VmsMessageInformationTypeEnum" maxOccurs="unbounded" minOccurs="0"/>
         <element name="primarySetting" type="{http://datex2.eu/schema/2/2_0}Boolean" minOccurs="0"/>
         <element name="mareNostrumCompliant" type="{http://datex2.eu/schema/2/2_0}Boolean" minOccurs="0"/>
         <element name="timeLastSet" type="{http://datex2.eu/schema/2/2_0}DateTime"/>
         <element name="requestedBy" type="{http://datex2.eu/schema/2/2_0}MultilingualString" minOccurs="0"/>
         <element name="situationToWhichMessageIsRelated" type="{http://datex2.eu/schema/2/2_0}VersionedReference" minOccurs="0"/>
         <element name="situationRecordToWhichMessageIsRelated" type="{http://datex2.eu/schema/2/2_0}VersionedReference" minOccurs="0"/>
         <element name="distanceFromSituationRecord" type="{http://datex2.eu/schema/2/2_0}MetresAsFloat" minOccurs="0"/>
         <element name="textPictogramSequencingInterval" type="{http://datex2.eu/schema/2/2_0}Seconds" minOccurs="0"/>
         <element name="textPage" type="{http://datex2.eu/schema/2/2_0}_TextPage" maxOccurs="unbounded" minOccurs="0"/>
         <element name="vmsPictogramDisplayArea" type="{http://datex2.eu/schema/2/2_0}_VmsMessagePictogramDisplayAreaIndexVmsPictogramDisplayArea" maxOccurs="unbounded" minOccurs="0"/>
         <element name="vmsMessageExtension" type="{http://datex2.eu/schema/2/2_0}_ExtensionType" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`associatedManagementOrDiversionPlan`
`protected CodedReasonForSettingMessageEnum`	`codedReasonForSetting`
`protected Float`	`distanceFromSituationRecord`
`protected Boolean`	`mareNostrumCompliant`
`protected MultilingualString`	`messageSetBy`
`protected Boolean`	`primarySetting`
`protected MultilingualString`	`reasonForSetting`
`protected MultilingualString`	`requestedBy`
`protected Boolean`	`setBySystem`
`protected VersionedReference`	`situationRecordToWhichMessageIsRelated`
`protected VersionedReference`	`situationToWhichMessageIsRelated`
`protected List<TextPage>`	`textPage`
`protected Float`	`textPictogramSequencingInterval`
`protected Calendar`	`timeLastSet`
`protected ExtensionType`	`vmsMessageExtension`
`protected List<VmsMessageInformationTypeEnum>`	`vmsMessageInformationType`
`protected List<VmsMessagePictogramDisplayAreaIndexVmsPictogramDisplayArea>`	`vmsPictogramDisplayArea`

Constructor Summary

Constructors
Constructor and Description

VmsMessage()

Constructors
Constructor and Description
`VmsMessage()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getAssociatedManagementOrDiversionPlan()` Gets the value of the associatedManagementOrDiversionPlan property.
`CodedReasonForSettingMessageEnum`	`getCodedReasonForSetting()` Gets the value of the codedReasonForSetting property.
`Float`	`getDistanceFromSituationRecord()` Gets the value of the distanceFromSituationRecord property.
`MultilingualString`	`getMessageSetBy()` Gets the value of the messageSetBy property.
`MultilingualString`	`getReasonForSetting()` Gets the value of the reasonForSetting property.
`MultilingualString`	`getRequestedBy()` Gets the value of the requestedBy property.
`VersionedReference`	`getSituationRecordToWhichMessageIsRelated()` Gets the value of the situationRecordToWhichMessageIsRelated property.
`VersionedReference`	`getSituationToWhichMessageIsRelated()` Gets the value of the situationToWhichMessageIsRelated property.
`List<TextPage>`	`getTextPage()` Gets the value of the textPage property.
`Float`	`getTextPictogramSequencingInterval()` Gets the value of the textPictogramSequencingInterval property.
`Calendar`	`getTimeLastSet()` Gets the value of the timeLastSet property.
`ExtensionType`	`getVmsMessageExtension()` Gets the value of the vmsMessageExtension property.
`List<VmsMessageInformationTypeEnum>`	`getVmsMessageInformationType()` Gets the value of the vmsMessageInformationType property.
`List<VmsMessagePictogramDisplayAreaIndexVmsPictogramDisplayArea>`	`getVmsPictogramDisplayArea()` Gets the value of the vmsPictogramDisplayArea property.
`Boolean`	`isMareNostrumCompliant()` Gets the value of the mareNostrumCompliant property.
`Boolean`	`isPrimarySetting()` Gets the value of the primarySetting property.
`Boolean`	`isSetBySystem()` Gets the value of the setBySystem property.
`void`	`setAssociatedManagementOrDiversionPlan(String value)` Sets the value of the associatedManagementOrDiversionPlan property.
`void`	`setCodedReasonForSetting(CodedReasonForSettingMessageEnum value)` Sets the value of the codedReasonForSetting property.
`void`	`setDistanceFromSituationRecord(Float value)` Sets the value of the distanceFromSituationRecord property.
`void`	`setMareNostrumCompliant(Boolean value)` Sets the value of the mareNostrumCompliant property.
`void`	`setMessageSetBy(MultilingualString value)` Sets the value of the messageSetBy property.
`void`	`setPrimarySetting(Boolean value)` Sets the value of the primarySetting property.
`void`	`setReasonForSetting(MultilingualString value)` Sets the value of the reasonForSetting property.
`void`	`setRequestedBy(MultilingualString value)` Sets the value of the requestedBy property.
`void`	`setSetBySystem(Boolean value)` Sets the value of the setBySystem property.
`void`	`setSituationRecordToWhichMessageIsRelated(VersionedReference value)` Sets the value of the situationRecordToWhichMessageIsRelated property.
`void`	`setSituationToWhichMessageIsRelated(VersionedReference value)` Sets the value of the situationToWhichMessageIsRelated property.
`void`	`setTextPictogramSequencingInterval(Float value)` Sets the value of the textPictogramSequencingInterval property.
`void`	`setTimeLastSet(Calendar value)` Sets the value of the timeLastSet property.
`void`	`setVmsMessageExtension(ExtensionType value)` Sets the value of the vmsMessageExtension property.

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

- Field Detail
  - associatedManagementOrDiversionPlan
```
protected String associatedManagementOrDiversionPlan
```
  - messageSetBy
```
protected MultilingualString messageSetBy
```
  - setBySystem
```
protected Boolean setBySystem
```
  - reasonForSetting
```
protected MultilingualString reasonForSetting
```
  - codedReasonForSetting
```
protected CodedReasonForSettingMessageEnum codedReasonForSetting
```
  - vmsMessageInformationType
```
protected List<VmsMessageInformationTypeEnum> vmsMessageInformationType
```
  - primarySetting
```
protected Boolean primarySetting
```
  - mareNostrumCompliant
```
protected Boolean mareNostrumCompliant
```
  - timeLastSet
```
protected Calendar timeLastSet
```
  - requestedBy
```
protected MultilingualString requestedBy
```
  - situationToWhichMessageIsRelated
```
protected VersionedReference situationToWhichMessageIsRelated
```
  - situationRecordToWhichMessageIsRelated
```
protected VersionedReference situationRecordToWhichMessageIsRelated
```
  - distanceFromSituationRecord
```
protected Float distanceFromSituationRecord
```
  - textPictogramSequencingInterval
```
protected Float textPictogramSequencingInterval
```
  - textPage
```
protected List<TextPage> textPage
```
  - vmsPictogramDisplayArea
```
protected List<VmsMessagePictogramDisplayAreaIndexVmsPictogramDisplayArea> vmsPictogramDisplayArea
```
  - vmsMessageExtension
```
protected ExtensionType vmsMessageExtension
```
- Constructor Detail
  - VmsMessage
```
public VmsMessage()
```
- Method Detail
  - getAssociatedManagementOrDiversionPlan
```
public String getAssociatedManagementOrDiversionPlan()
```
    Gets the value of the associatedManagementOrDiversionPlan property.
    
    Returns:
    possible object is String
  - setAssociatedManagementOrDiversionPlan
```
public void setAssociatedManagementOrDiversionPlan(String value)
```
    Sets the value of the associatedManagementOrDiversionPlan property.
    
    Parameters:
    value - allowed object is String
  - getMessageSetBy
```
public MultilingualString getMessageSetBy()
```
    Gets the value of the messageSetBy property.
    
    Returns:
    possible object is MultilingualString
  - setMessageSetBy
```
public void setMessageSetBy(MultilingualString value)
```
    Sets the value of the messageSetBy property.
    
    Parameters:
    value - allowed object is MultilingualString
  - isSetBySystem
```
public Boolean isSetBySystem()
```
    Gets the value of the setBySystem property.
    
    Returns:
    possible object is Boolean
  - setSetBySystem
```
public void setSetBySystem(Boolean value)
```
    Sets the value of the setBySystem property.
    
    Parameters:
    value - allowed object is Boolean
  - getReasonForSetting
```
public MultilingualString getReasonForSetting()
```
    Gets the value of the reasonForSetting property.
    
    Returns:
    possible object is MultilingualString
  - setReasonForSetting
```
public void setReasonForSetting(MultilingualString value)
```
    Sets the value of the reasonForSetting property.
    
    Parameters:
    value - allowed object is MultilingualString
  - getCodedReasonForSetting
```
public CodedReasonForSettingMessageEnum getCodedReasonForSetting()
```
    Gets the value of the codedReasonForSetting property.
    
    Returns:
    possible object is CodedReasonForSettingMessageEnum
  - setCodedReasonForSetting
```
public void setCodedReasonForSetting(CodedReasonForSettingMessageEnum value)
```
    Sets the value of the codedReasonForSetting property.
    
    Parameters:
    value - allowed object is CodedReasonForSettingMessageEnum
  - getVmsMessageInformationType
```
public List<VmsMessageInformationTypeEnum> getVmsMessageInformationType()
```
    Gets the value of the vmsMessageInformationType 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 vmsMessageInformationType property.
    For example, to add a new item, do as follows:
```
    getVmsMessageInformationType().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list VmsMessageInformationTypeEnum
  - isPrimarySetting
```
public Boolean isPrimarySetting()
```
    Gets the value of the primarySetting property.
    
    Returns:
    possible object is Boolean
  - setPrimarySetting
```
public void setPrimarySetting(Boolean value)
```
    Sets the value of the primarySetting property.
    
    Parameters:
    value - allowed object is Boolean
  - isMareNostrumCompliant
```
public Boolean isMareNostrumCompliant()
```
    Gets the value of the mareNostrumCompliant property.
    
    Returns:
    possible object is Boolean
  - setMareNostrumCompliant
```
public void setMareNostrumCompliant(Boolean value)
```
    Sets the value of the mareNostrumCompliant property.
    
    Parameters:
    value - allowed object is Boolean
  - getTimeLastSet
```
public Calendar getTimeLastSet()
```
    Gets the value of the timeLastSet property.
    
    Returns:
    possible object is String
  - setTimeLastSet
```
public void setTimeLastSet(Calendar value)
```
    Sets the value of the timeLastSet property.
    
    Parameters:
    value - allowed object is String
  - getRequestedBy
```
public MultilingualString getRequestedBy()
```
    Gets the value of the requestedBy property.
    
    Returns:
    possible object is MultilingualString
  - setRequestedBy
```
public void setRequestedBy(MultilingualString value)
```
    Sets the value of the requestedBy property.
    
    Parameters:
    value - allowed object is MultilingualString
  - getSituationToWhichMessageIsRelated
```
public VersionedReference getSituationToWhichMessageIsRelated()
```
    Gets the value of the situationToWhichMessageIsRelated property.
    
    Returns:
    possible object is VersionedReference
  - setSituationToWhichMessageIsRelated
```
public void setSituationToWhichMessageIsRelated(VersionedReference value)
```
    Sets the value of the situationToWhichMessageIsRelated property.
    
    Parameters:
    value - allowed object is VersionedReference
  - getSituationRecordToWhichMessageIsRelated
```
public VersionedReference getSituationRecordToWhichMessageIsRelated()
```
    Gets the value of the situationRecordToWhichMessageIsRelated property.
    
    Returns:
    possible object is VersionedReference
  - setSituationRecordToWhichMessageIsRelated
```
public void setSituationRecordToWhichMessageIsRelated(VersionedReference value)
```
    Sets the value of the situationRecordToWhichMessageIsRelated property.
    
    Parameters:
    value - allowed object is VersionedReference
  - getDistanceFromSituationRecord
```
public Float getDistanceFromSituationRecord()
```
    Gets the value of the distanceFromSituationRecord property.
    
    Returns:
    possible object is Float
  - setDistanceFromSituationRecord
```
public void setDistanceFromSituationRecord(Float value)
```
    Sets the value of the distanceFromSituationRecord property.
    
    Parameters:
    value - allowed object is Float
  - getTextPictogramSequencingInterval
```
public Float getTextPictogramSequencingInterval()
```
    Gets the value of the textPictogramSequencingInterval property.
    
    Returns:
    possible object is Float
  - setTextPictogramSequencingInterval
```
public void setTextPictogramSequencingInterval(Float value)
```
    Sets the value of the textPictogramSequencingInterval property.
    
    Parameters:
    value - allowed object is Float
  - getTextPage
```
public List<TextPage> getTextPage()
```
    Gets the value of the textPage 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 textPage property.
    For example, to add a new item, do as follows:
```
    getTextPage().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list TextPage
  - getVmsPictogramDisplayArea
```
public List<VmsMessagePictogramDisplayAreaIndexVmsPictogramDisplayArea> getVmsPictogramDisplayArea()
```
    Gets the value of the vmsPictogramDisplayArea 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 vmsPictogramDisplayArea property.
    For example, to add a new item, do as follows:
```
    getVmsPictogramDisplayArea().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list VmsMessagePictogramDisplayAreaIndexVmsPictogramDisplayArea
  - getVmsMessageExtension
```
public ExtensionType getVmsMessageExtension()
```
    Gets the value of the vmsMessageExtension property.
    
    Returns:
    possible object is ExtensionType
  - setVmsMessageExtension
```
public void setVmsMessageExtension(ExtensionType value)
```
    Sets the value of the vmsMessageExtension property.
    
    Parameters:
    value - allowed object is ExtensionType

Class VmsMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

associatedManagementOrDiversionPlan

messageSetBy

setBySystem

reasonForSetting

codedReasonForSetting

vmsMessageInformationType

primarySetting

mareNostrumCompliant

timeLastSet

requestedBy

situationToWhichMessageIsRelated

situationRecordToWhichMessageIsRelated

distanceFromSituationRecord

textPictogramSequencingInterval

textPage

vmsPictogramDisplayArea

vmsMessageExtension

Constructor Detail

VmsMessage

Method Detail

getAssociatedManagementOrDiversionPlan

setAssociatedManagementOrDiversionPlan

getMessageSetBy

setMessageSetBy

isSetBySystem

setSetBySystem

getReasonForSetting

setReasonForSetting

getCodedReasonForSetting

setCodedReasonForSetting

getVmsMessageInformationType

isPrimarySetting

setPrimarySetting

isMareNostrumCompliant

setMareNostrumCompliant

getTimeLastSet

setTimeLastSet

getRequestedBy

setRequestedBy

getSituationToWhichMessageIsRelated

setSituationToWhichMessageIsRelated

getSituationRecordToWhichMessageIsRelated

setSituationRecordToWhichMessageIsRelated

getDistanceFromSituationRecord

setDistanceFromSituationRecord

getTextPictogramSequencingInterval

setTextPictogramSequencingInterval

getTextPage

getVmsPictogramDisplayArea

getVmsMessageExtension

setVmsMessageExtension