Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.sdmx.resources.sdmxml.schemas.v2_0.message
Class HeaderType

java.lang.Object
  extended by org.sdmx.resources.sdmxml.schemas.v2_0.message.HeaderType

public class HeaderType
extends Object

HeaderType defines the header fields used for all messages. ID identifies a data flow definition, which, when combined with time, uniquely identifies the data set. Test indicates whather the message is for test purposes or not. Truncated is used in data messages which are responding to Query messages, and is set to true only if the response has been truncated to meet size limits suggested by the defaultLimit attribute in the Query mesage. Name provides a name for the transmission. Prepared is the date prepared. Sender is information about the sender, and Receiver is information about the receiver. Agency provides the code identifier/abbreviation for the maintenance agency of a data set. Data set id provides an identifier for a contained data set. Action code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message). KeyFamilyRef is used to reference a key family for a contained data set, using its id. (This information is required at the DataSet level for some messages, but is provided here as a convenience for those messages which do not require it.) KeyFamilyAgency specifies the agency of the key family using its coded id. Fields which refer to a contained data set need not be used if the message contains a query or structural information - these messages provide specific fields for holding this information. The ones here are not to be used as defaults. Extracted is a time-stamp from the system rendering the data; ReportingBegin and ReportingEnd provide the time period covered by the message (in the case of data). Source provides human-readable information about the source of the data.

Java class for HeaderType complex type.

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

 <complexType name="HeaderType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="ID" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}IDType"/>
         <element name="Test" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="Truncated" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="Name" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TextType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="Prepared" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/message}HeaderTimeType"/>
         <element name="Sender" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/message}PartyType" maxOccurs="unbounded"/>
         <element name="Receiver" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/message}PartyType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="KeyFamilyRef" type="{http://www.w3.org/2001/XMLSchema}NMTOKEN" minOccurs="0"/>
         <element name="KeyFamilyAgency" type="{http://www.w3.org/2001/XMLSchema}NMTOKEN" minOccurs="0"/>
         <element name="DataSetAgency" type="{http://www.w3.org/2001/XMLSchema}NMTOKEN" minOccurs="0"/>
         <element name="DataSetID" type="{http://www.w3.org/2001/XMLSchema}NMTOKEN" minOccurs="0"/>
         <element name="DataSetAction" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}ActionType" 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_0/message}HeaderTimeType" minOccurs="0"/>
         <element name="ReportingEnd" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/message}HeaderTimeType" minOccurs="0"/>
         <element name="Source" type="{http://www.SDMX.org/resources/SDMXML/schemas/v2_0/common}TextType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary
protected  ActionType dataSetAction
           
protected  String dataSetAgency
           
protected  String dataSetID
           
protected  XMLGregorianCalendar extracted
           
protected  String id
           
protected  String keyFamilyAgency
           
protected  String keyFamilyRef
           
protected  List<TextType> name
           
protected  String prepared
           
protected  List<PartyType> receiver
           
protected  String reportingBegin
           
protected  String reportingEnd
           
protected  List<PartyType> sender
           
protected  List<TextType> source
           
protected  boolean test
           
protected  Boolean truncated
           
 
Constructor Summary
HeaderType()
           
 
Method Summary
 ActionType getDataSetAction()
          Gets the value of the dataSetAction property.
 String getDataSetAgency()
          Gets the value of the dataSetAgency property.
 String getDataSetID()
          Gets the value of the dataSetID property.
 XMLGregorianCalendar getExtracted()
          Gets the value of the extracted property.
 String getID()
          Gets the value of the id property.
 String getKeyFamilyAgency()
          Gets the value of the keyFamilyAgency property.
 String getKeyFamilyRef()
          Gets the value of the keyFamilyRef property.
 List<TextType> getName()
          Gets the value of the name property.
 String getPrepared()
          Gets the value of the prepared property.
 List<PartyType> getReceiver()
          Gets the value of the receiver property.
 String getReportingBegin()
          Gets the value of the reportingBegin property.
 String getReportingEnd()
          Gets the value of the reportingEnd property.
 List<PartyType> getSender()
          Gets the value of the sender property.
 List<TextType> getSource()
          Gets the value of the source property.
 boolean isTest()
          Gets the value of the test property.
 Boolean isTruncated()
          Gets the value of the truncated property.
 void setDataSetAction(ActionType value)
          Sets the value of the dataSetAction property.
 void setDataSetAgency(String value)
          Sets the value of the dataSetAgency property.
 void setDataSetID(String value)
          Sets the value of the dataSetID property.
 void setExtracted(XMLGregorianCalendar value)
          Sets the value of the extracted property.
 void setID(String value)
          Sets the value of the id property.
 void setKeyFamilyAgency(String value)
          Sets the value of the keyFamilyAgency property.
 void setKeyFamilyRef(String value)
          Sets the value of the keyFamilyRef property.
 void setPrepared(String value)
          Sets the value of the prepared property.
 void setReportingBegin(String value)
          Sets the value of the reportingBegin property.
 void setReportingEnd(String value)
          Sets the value of the reportingEnd property.
 void setTest(boolean value)
          Sets the value of the test property.
 void setTruncated(Boolean value)
          Sets the value of the truncated 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

truncated

protected Boolean truncated

name

protected List<TextType> name

prepared

protected String prepared

sender

protected List<PartyType> sender

receiver

protected List<PartyType> receiver

keyFamilyRef

protected String keyFamilyRef

keyFamilyAgency

protected String keyFamilyAgency

dataSetAgency

protected String dataSetAgency

dataSetID

protected String dataSetID

dataSetAction

protected ActionType dataSetAction

extracted

protected XMLGregorianCalendar extracted

reportingBegin

protected String reportingBegin

reportingEnd

protected String reportingEnd

source

protected List<TextType> source
Constructor Detail

HeaderType

public HeaderType()
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.

isTruncated

public Boolean isTruncated()
Gets the value of the truncated property.

Returns:
possible object is Boolean

setTruncated

public void setTruncated(Boolean value)
Sets the value of the truncated property.

Parameters:
value - allowed object is Boolean

getName

public List<TextType> getName()
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

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 List<PartyType> getSender()
Gets the value of the sender 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 sender property.

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

    getSender().add(newItem);

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

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

getKeyFamilyRef

public String getKeyFamilyRef()
Gets the value of the keyFamilyRef property.

Returns:
possible object is String

setKeyFamilyRef

public void setKeyFamilyRef(String value)
Sets the value of the keyFamilyRef property.

Parameters:
value - allowed object is String

getKeyFamilyAgency

public String getKeyFamilyAgency()
Gets the value of the keyFamilyAgency property.

Returns:
possible object is String

setKeyFamilyAgency

public void setKeyFamilyAgency(String value)
Sets the value of the keyFamilyAgency property.

Parameters:
value - allowed object is String

getDataSetAgency

public String getDataSetAgency()
Gets the value of the dataSetAgency property.

Returns:
possible object is String

setDataSetAgency

public void setDataSetAgency(String value)
Sets the value of the dataSetAgency property.

Parameters:
value - allowed object is String

getDataSetID

public String getDataSetID()
Gets the value of the dataSetID property.

Returns:
possible object is String

setDataSetID

public void setDataSetID(String value)
Sets the value of the dataSetID property.

Parameters:
value - allowed object is String

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

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 String getReportingBegin()
Gets the value of the reportingBegin property.

Returns:
possible object is String

setReportingBegin

public void setReportingBegin(String value)
Sets the value of the reportingBegin property.

Parameters:
value - allowed object is String

getReportingEnd

public String getReportingEnd()
Gets the value of the reportingEnd property.

Returns:
possible object is String

setReportingEnd

public void setReportingEnd(String value)
Sets the value of the reportingEnd property.

Parameters:
value - allowed object is String

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

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2012. All Rights Reserved.