org.sdmxsource.sdmx.api.model.header

Interface HeaderBean

All Known Implementing Classes:

HeaderBeanImpl

public interface HeaderBean

A Header Contains any information to go at the beginning of an exchange message.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATASET_AGENCY
static java.lang.String	DSD_AGENCY_REF
static java.lang.String	DSD_REF

Method Summary

Methods

Modifier and Type	Method and Description
void	addName(TextTypeWrapper name) Adds a name to the list
void	addReceiver(PartyBean receiver) Adds a receiver to the list of receivers
void	addSource(TextTypeWrapper source) Adds a source to the list of sources
void	addStructure(DatasetStructureReferenceBean ref) Adds a dataset structure reference to the list
DATASET_ACTION	getAction() Gets the action for the message
java.lang.String	getAdditionalAttribute(java.lang.String headerField) Returns the header value for a given field.
java.util.Map<java.lang.String,java.lang.String>	getAdditionalAttributes() Returns a map of any additional attributes that are stored in the header - the key is the field, such as Header.DSD_REF, the value is the value of that field
StructureReferenceBean	getDataProviderReference() Returns the data provider reference
java.lang.String	getDatasetId() Gets a dataset id for the message
java.util.Date	getEmbargoDate() Returns the embargo date for the message
java.util.Date	getExtracted() Returns the extracted date for the message
java.lang.String	getId() Gets the id of the header
java.util.List<TextTypeWrapper>	getName() Returns the name, or an empty list if none are defined
java.util.Date	getPrepared() Returns the prepared date for the message
java.util.List<PartyBean>	getReceiver() Returns the list of receivers or an empty list if none are defined
java.util.Date	getReportingBegin() Returns the reporting begin date
java.util.Date	getReportingEnd() Returns the reporting end date
PartyBean	getSender() Returns the sender
java.util.List<TextTypeWrapper>	getSource() Returns the list of sources, or an empty list if none are defined
DatasetStructureReferenceBean	getStructureById(java.lang.String structureId) Returns the structure for the given id
java.util.List<DatasetStructureReferenceBean>	getStructures() Returns all data structure references
boolean	hasAdditionalAttribute(java.lang.String headerField) Returns true if this Header instance has a value stored for this property in its additional attributes @See getAdditionalAttributes()
boolean	isTest() Returns true if this is a test message
void	setAction(DATASET_ACTION action) Sets the action for the message
void	setDataProviderReference(StructureReferenceBean dataProvider) Sets the data provider reference
void	setDatasetId(java.lang.String datasetId) Sets a dataset id for the message
void	setEmbargoDate(java.util.Date embargoDate) Sets the embargo date for the message
void	setId(java.lang.String id) Sets the id of the message, can not be null
void	setReportingBegin(java.util.Date date) Sets the reporting being date
void	setReportingEnd(java.util.Date date) Sets the reporting end date
void	setSender(PartyBean party) Sets the sender (can not be null)
void	setTest(boolean test) True if this is a test message

Field Detail

DSD_REF

static final java.lang.String DSD_REF

See Also:

Constant Field Values

DSD_AGENCY_REF

static final java.lang.String DSD_AGENCY_REF

See Also:

Constant Field Values

DATASET_AGENCY

static final java.lang.String DATASET_AGENCY

See Also:

Constant Field Values

Method Detail

hasAdditionalAttribute

boolean hasAdditionalAttribute(java.lang.String headerField)

Returns true if this Header instance has a value stored for this property in its additional attributes @See getAdditionalAttributes()

Parameters:

headerField -

Returns:

getAdditionalAttribute

java.lang.String getAdditionalAttribute(java.lang.String headerField)

Returns the header value for a given field. For example getHeaderValue(Header.DSD_REF) would return the value given for the keyFamilyRef (SDMX 2.0)

Parameters:

headerField -

Returns:

getAdditionalAttributes

java.util.Map<java.lang.String,java.lang.String> getAdditionalAttributes()

Returns a map of any additional attributes that are stored in the header - the key is the field, such as Header.DSD_REF, the value is the value of that field

Returns:

getDataProviderReference

StructureReferenceBean getDataProviderReference()

Returns the data provider reference

Returns:

setDataProviderReference

void setDataProviderReference(StructureReferenceBean dataProvider)

Sets the data provider reference

Parameters:

dataProvider -

getAction

DATASET_ACTION getAction()

Gets the action for the message

Returns:

setAction

void setAction(DATASET_ACTION action)

Sets the action for the message

Parameters:

action -

getId

java.lang.String getId()

Gets the id of the header

Returns:

setId

void setId(java.lang.String id)

Sets the id of the message, can not be null

Parameters:

id -

getDatasetId

java.lang.String getDatasetId()

Gets a dataset id for the message

Returns:

setDatasetId

void setDatasetId(java.lang.String datasetId)

Sets a dataset id for the message

Parameters:

datasetId -

getEmbargoDate

java.util.Date getEmbargoDate()

Returns the embargo date for the message

Returns:

embargo of null if undefined

setEmbargoDate

void setEmbargoDate(java.util.Date embargoDate)

Sets the embargo date for the message

Parameters:

embargoDate -

getExtracted

java.util.Date getExtracted()

Returns the extracted date for the message

Returns:

extracted or null if undefined

getPrepared

java.util.Date getPrepared()

Returns the prepared date for the message

Returns:

prepared or null if undefined

getName

java.util.List<TextTypeWrapper> getName()

Returns the name, or an empty list if none are defined

Returns:

addName

void addName(TextTypeWrapper name)

Adds a name to the list

Parameters:

name -

getReceiver

java.util.List<PartyBean> getReceiver()

Returns the list of receivers or an empty list if none are defined

Returns:

addReceiver

void addReceiver(PartyBean receiver)

Adds a receiver to the list of receivers

Parameters:

receiver -

getReportingBegin

java.util.Date getReportingBegin()

Returns the reporting begin date

Returns:

setReportingBegin

void setReportingBegin(java.util.Date date)

Sets the reporting being date

Parameters:

date -

getReportingEnd

java.util.Date getReportingEnd()

Returns the reporting end date

Returns:

setReportingEnd

void setReportingEnd(java.util.Date date)

Sets the reporting end date

Parameters:

date -

getSource

java.util.List<TextTypeWrapper> getSource()

Returns the list of sources, or an empty list if none are defined

Returns:

addSource

void addSource(TextTypeWrapper source)

Adds a source to the list of sources

Parameters:

source -

getSender

PartyBean getSender()

Returns the sender

Returns:

setSender

void setSender(PartyBean party)

Sets the sender (can not be null)

Parameters:

party -

isTest

boolean isTest()

Returns true if this is a test message

Returns:

setTest

void setTest(boolean test)

True if this is a test message

Parameters:

test -

getStructureById

DatasetStructureReferenceBean getStructureById(java.lang.String structureId)

Returns the structure for the given id

Parameters:

structureId -

Returns:

getStructures

java.util.List<DatasetStructureReferenceBean> getStructures()

Returns all data structure references

Returns:

addStructure

void addStructure(DatasetStructureReferenceBean ref)

Adds a dataset structure reference to the list