org.sdmx.resources.sdmxml.schemas.v2_1.message
Class BaseHeaderType

java.lang.Object
  org.sdmx.resources.sdmxml.schemas.v2_1.message.BaseHeaderType

Direct Known Subclasses:

BasicHeaderType, GenericDataHeaderType, GenericMetadataHeaderType, StructureHeaderType, StructureSpecificDataHeaderType, StructureSpecificMetadataHeaderType

public abstract class BaseHeaderType
extends Object

BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this

Java class for BaseHeaderType complex type.

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

 <complexType name="BaseHeaderType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="ID" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}IDType"/>
         <element name="Test" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="Prepared" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/message}HeaderTimeType"/>
         <element name="Sender" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/message}SenderType"/>
         <element name="Receiver" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/message}PartyType" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}Name" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Structure" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}PayloadStructureType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="DataProvider" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}DataProviderReferenceType" minOccurs="0"/>
         <element name="DataSetAction" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}ActionType" minOccurs="0"/>
         <element name="DataSetID" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}IDType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Extracted" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="ReportingBegin" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}ObservationalTimePeriodType" minOccurs="0"/>
         <element name="ReportingEnd" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}ObservationalTimePeriodType" minOccurs="0"/>
         <element name="EmbargoDate" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="Source" type="{http://www.sdmx.org/resources/sdmxml/schemas/v2_1/common}TextType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected DataProviderReferenceType	dataProvider
protected ActionType	dataSetAction
protected List<String>	dataSetID
protected XMLGregorianCalendar	embargoDate
protected XMLGregorianCalendar	extracted
protected String	id
protected List<TextType>	name
protected String	prepared
protected List<PartyType>	receiver
protected List<String>	reportingBegin
protected List<String>	reportingEnd
protected SenderType	sender
protected List<TextType>	source
protected List<PayloadStructureType>	structure
protected boolean	test

Constructor Summary

BaseHeaderType()

Method Summary

DataProviderReferenceType	getDataProvider() Gets the value of the dataProvider property.
ActionType	getDataSetAction() Gets the value of the dataSetAction property.
List<String>	getDataSetID() Gets the value of the dataSetID property.
XMLGregorianCalendar	getEmbargoDate() Gets the value of the embargoDate property.
XMLGregorianCalendar	getExtracted() Gets the value of the extracted property.
String	getID() Gets the value of the id property.
List<TextType>	getName() Name provides a name for the transmission.
String	getPrepared() Gets the value of the prepared property.
List<PartyType>	getReceiver() Gets the value of the receiver property.
List<String>	getReportingBegin() Gets the value of the reportingBegin property.
List<String>	getReportingEnd() Gets the value of the reportingEnd property.
SenderType	getSender() Gets the value of the sender property.
List<TextType>	getSource() Gets the value of the source property.
List<PayloadStructureType>	getStructure() Gets the value of the structure property.
boolean	isTest() Gets the value of the test property.
void	setDataProvider(DataProviderReferenceType value) Sets the value of the dataProvider property.
void	setDataSetAction(ActionType value) Sets the value of the dataSetAction property.
void	setEmbargoDate(XMLGregorianCalendar value) Sets the value of the embargoDate property.
void	setExtracted(XMLGregorianCalendar value) Sets the value of the extracted property.
void	setID(String value) Sets the value of the id property.
void	setPrepared(String value) Sets the value of the prepared property.
void	setSender(SenderType value) Sets the value of the sender property.
void	setTest(boolean value) Sets the value of the test property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

protected String id

test

protected boolean test

prepared

protected String prepared

sender

protected SenderType sender

receiver

protected List<PartyType> receiver

name

protected List<TextType> name

structure

protected List<PayloadStructureType> structure

dataProvider

protected DataProviderReferenceType dataProvider

dataSetAction

protected ActionType dataSetAction

dataSetID

protected List<String> dataSetID

extracted

protected XMLGregorianCalendar extracted

reportingBegin

protected List<String> reportingBegin

reportingEnd

protected List<String> reportingEnd

embargoDate

protected XMLGregorianCalendar embargoDate

source

protected List<TextType> source

Constructor Detail

BaseHeaderType

public BaseHeaderType()

Method Detail

getID

public String getID()

Gets the value of the id property.

Returns:

possible object is String

setID

public void setID(String value)

Sets the value of the id property.

Parameters:

value - allowed object is String

isTest

public boolean isTest()

Gets the value of the test property.

setTest

public void setTest(boolean value)

Sets the value of the test property.

getPrepared

public String getPrepared()

Gets the value of the prepared property.

Returns:

possible object is String

setPrepared

public void setPrepared(String value)

Sets the value of the prepared property.

Parameters:

value - allowed object is String

getSender

public SenderType getSender()

Gets the value of the sender property.

Returns:

possible object is SenderType

setSender

public void setSender(SenderType value)

Sets the value of the sender property.

Parameters:

value - allowed object is SenderType

getReceiver

public List<PartyType> getReceiver()

Gets the value of the receiver 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 receiver property.

For example, to add a new item, do as follows:

    getReceiver().add(newItem);
 

Objects of the following type(s) are allowed in the list PartyType

getName

public List<TextType> getName()

Name provides a name for the transmission. Multiple instances allow for parallel language values.Gets the value of the name 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 name property.

For example, to add a new item, do as follows:

    getName().add(newItem);
 

Objects of the following type(s) are allowed in the list TextType

getStructure

public List<PayloadStructureType> getStructure()

Gets the value of the structure 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 structure property.

For example, to add a new item, do as follows:

    getStructure().add(newItem);
 

Objects of the following type(s) are allowed in the list PayloadStructureType

getDataProvider

public DataProviderReferenceType getDataProvider()

Gets the value of the dataProvider property.

Returns:

possible object is DataProviderReferenceType

setDataProvider

public void setDataProvider(DataProviderReferenceType value)

Sets the value of the dataProvider property.

Parameters:

value - allowed object is DataProviderReferenceType

getDataSetAction

public ActionType getDataSetAction()

Gets the value of the dataSetAction property.

Returns:

possible object is ActionType

setDataSetAction

public void setDataSetAction(ActionType value)

Sets the value of the dataSetAction property.

Parameters:

value - allowed object is ActionType

getDataSetID

public List<String> getDataSetID()

Gets the value of the dataSetID 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 dataSetID property.

For example, to add a new item, do as follows:

    getDataSetID().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getExtracted

public XMLGregorianCalendar getExtracted()

Gets the value of the extracted property.

Returns:

possible object is XMLGregorianCalendar

setExtracted

public void setExtracted(XMLGregorianCalendar value)

Sets the value of the extracted property.

Parameters:

value - allowed object is XMLGregorianCalendar

getReportingBegin

public List<String> getReportingBegin()

Gets the value of the reportingBegin 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 reportingBegin property.

For example, to add a new item, do as follows:

    getReportingBegin().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getReportingEnd

public List<String> getReportingEnd()

Gets the value of the reportingEnd 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 reportingEnd property.

For example, to add a new item, do as follows:

    getReportingEnd().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getEmbargoDate

public XMLGregorianCalendar getEmbargoDate()

Gets the value of the embargoDate property.

Returns:

possible object is XMLGregorianCalendar

setEmbargoDate

public void setEmbargoDate(XMLGregorianCalendar value)

Sets the value of the embargoDate property.

Parameters:

value - allowed object is XMLGregorianCalendar

getSource

public List<TextType> getSource()

Gets the value of the source 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 source property.

For example, to add a new item, do as follows:

    getSource().add(newItem);
 

Objects of the following type(s) are allowed in the list TextType