com.prowidesoftware.swift.model.mx

Class BusinessAppHdrV03

java.lang.Object

com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV03Impl

com.prowidesoftware.swift.model.mx.BusinessAppHdrV03

All Implemented Interfaces:

AppHdr

public class BusinessAppHdrV03
extends com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV03Impl
implements AppHdr

ISO 20022 business application header version 3 usually known by its namespace head.001.001.03

Since:

9.3.4

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAMESPACE

Fields inherited from class com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV03Impl

bizMsgIdr, bizPrcgDt, bizSvc, charSet, cpyDplct, creDt, fr, mktPrctc, msgDefIdr, prty, pssblDplct, rltd, sgntr, to

Fields inherited from interface com.prowidesoftware.swift.model.mx.AppHdr

HEADER_LOCALNAME

Constructor Summary

Constructors

Constructor and Description
BusinessAppHdrV03()

Method Summary

Modifier and Type	Method and Description
javax.xml.datatype.XMLGregorianCalendar	creationDate() Gets the creation date
boolean	duplicate() Gets the duplicate flag from the "PssblDplct" (BAH) or "Dup" (AH) element
org.w3c.dom.Element	element() Gets the header as an Element object.
java.lang.String	from() Gets the sender BIC code from these elements in the following order: BusinessApplicationHeaderV01/Fr/FIId/FinInstnId/BICFI BusinessApplicationHeaderV01/Fr/OrgId/Id/OrgId/Id/AnyBIC
java.lang.String	messageName() Gets the message name.
java.lang.String	namespace() Gets the specific namespace of the header
static BusinessAppHdrV03	parse(java.lang.String xml) Parse the header from an XML with optional wrapper and sibling elements that will be ignored.
static BusinessAppHdrV03	parse(java.lang.String xml, MxReadParams params) Parse the header from an XML with optional wrapper and sibling elements that will be ignored.
java.lang.String	reference() Get the message reference.
java.lang.String	serviceName() Gets the service name.
void	setCreationDate(boolean overwrite) Sets the creation date.
java.lang.String	to() Gets the receiver BIC code from these elements in the following order: BusinessApplicationHeaderV03/To/FIId/FinInstnId/BICFI BusinessApplicationHeaderV03/To/OrgId/Id/OrgId/Id/AnyBIC
java.lang.String	xml(MxWriteParams params) Get this header as an XML string.
java.lang.String	xml(java.lang.String prefix, boolean includeXMLDeclaration) Deprecated. use xml(MxWriteParams) instead
java.lang.String	xml(java.lang.String prefix, boolean includeXMLDeclaration, EscapeHandler escapeHandler) Deprecated. use xml(MxWriteParams) instead

Methods inherited from class com.prowidesoftware.swift.model.mx.dic.BusinessApplicationHeaderV03Impl

addRltd, equals, getBizMsgIdr, getBizPrcgDt, getBizSvc, getCharSet, getCpyDplct, getCreDt, getFr, getMktPrctc, getMsgDefIdr, getPrty, getRltd, getSgntr, getTo, hashCode, isPssblDplct, setBizMsgIdr, setBizPrcgDt, setBizSvc, setCharSet, setCpyDplct, setCreDt, setFr, setMktPrctc, setMsgDefIdr, setPrty, setPssblDplct, setSgntr, setTo, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.prowidesoftware.swift.model.mx.AppHdr

xml

Field Detail

NAMESPACE

public static final transient java.lang.String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

BusinessAppHdrV03

public BusinessAppHdrV03()

Method Detail

parse

public static BusinessAppHdrV03 parse(java.lang.String xml)

Parse the header from an XML with optional wrapper and sibling elements that will be ignored. Default adapters are applied, for more options use parse(String, MxReadParams)

Parameters:

xml - the XML content, can contain wrapper elements that will be ignored

Returns:

parsed element or null if cannot be parsed

Throws:

com.prowidesoftware.ProwideException - if severe errors occur during parse

parse

public static BusinessAppHdrV03 parse(java.lang.String xml,
                                      MxReadParams params)

Parse the header from an XML with optional wrapper and sibling elements that will be ignored.

Parameters:

xml - the XML content, can contain wrapper elements that will be ignored

params - not null unmarshalling parameters

Returns:

parsed element or null if cannot be parsed

Throws:

com.prowidesoftware.ProwideException - if severe errors occur during parse

from

public java.lang.String from()

Gets the sender BIC code from these elements in the following order:

1. BusinessApplicationHeaderV01/Fr/FIId/FinInstnId/BICFI
2. BusinessApplicationHeaderV01/Fr/OrgId/Id/OrgId/Id/AnyBIC

Specified by:

from in interface AppHdr

Returns:

found BIC or null if not present or cannot be parsed

to

public java.lang.String to()

Gets the receiver BIC code from these elements in the following order:

1. BusinessApplicationHeaderV03/To/FIId/FinInstnId/BICFI
2. BusinessApplicationHeaderV03/To/OrgId/Id/OrgId/Id/AnyBIC

Specified by:

to in interface AppHdr

Returns:

found BIC or null if not present or cannot be parsed

reference

public java.lang.String reference()

Get the message reference.

Specified by:

reference in interface AppHdr

Returns:

the message reference from the header or null if the element is not found

See Also:

BusinessApplicationHeaderV03Impl.getBizMsgIdr()

messageName

public java.lang.String messageName()

Gets the message name.

Specified by:

messageName in interface AppHdr

Returns:

the message name from the header or null if the element is not found

See Also:

BusinessApplicationHeaderV03Impl.getMsgDefIdr()

serviceName

public java.lang.String serviceName()

Gets the service name.

Specified by:

serviceName in interface AppHdr

Returns:

the service name from the header or null if the element is not found

See Also:

BusinessApplicationHeaderV03Impl.getBizSvc()

duplicate

public boolean duplicate()

Description copied from interface: AppHdr

Gets the duplicate flag from the "PssblDplct" (BAH) or "Dup" (AH) element

Specified by:

duplicate in interface AppHdr

Returns:

true if the CpyDplct element is present, false otherwise

See Also:

BusinessApplicationHeaderV03Impl.getCpyDplct()

creationDate

public javax.xml.datatype.XMLGregorianCalendar creationDate()

Gets the creation date

Specified by:

creationDate in interface AppHdr

Returns:

found date or null if the element is not found

See Also:

BusinessApplicationHeaderV03Impl.getCreDt()

setCreationDate

public void setCreationDate(boolean overwrite)

Sets the creation date.

Specified by:

setCreationDate in interface AppHdr

Parameters:

overwrite - if true, the creation date will always be set overwriting any previous value;

See Also:

BusinessApplicationHeaderV03Impl.setCreDt(XMLGregorianCalendar)

xml

@Deprecated
 @ProwideDeprecated(phase2=SRU2023)
public java.lang.String xml(java.lang.String prefix,
                                                                            boolean includeXMLDeclaration)

Deprecated. use xml(MxWriteParams) instead

Specified by:

xml in interface AppHdr

xml

@Deprecated
 @ProwideDeprecated(phase2=SRU2023)
public java.lang.String xml(java.lang.String prefix,
                                                                            boolean includeXMLDeclaration,
                                                                            EscapeHandler escapeHandler)

Deprecated. use xml(MxWriteParams) instead

Specified by:

xml in interface AppHdr

xml

public java.lang.String xml(MxWriteParams params)

Description copied from interface: AppHdr

Get this header as an XML string.

Specified by:

xml in interface AppHdr

Parameters:

params - not null marshalling parameters

Returns:

header serialized into XML string or null in case of unexpected error

element

public org.w3c.dom.Element element()

Description copied from interface: AppHdr

Gets the header as an Element object.

Specified by:

element in interface AppHdr

namespace

public java.lang.String namespace()

Description copied from interface: AppHdr

Gets the specific namespace of the header

Specified by:

namespace in interface AppHdr

Returns:

NAMESPACE