SWIFT::Factory::ApplicationHeader 0.02

SWIFT::Factory::ApplicationHeader is a Perl module that provides an Application Header Block (Block 2) for a SWIFT message.

SYNOPSIS

use SWIFT::Factory::ApplicationHeader;
my $hdr2=SWIFT::Factory::ApplicationHeader->new();

This class is primarily intended to be used by the different SWIFT::Factory::MTnnn modules to provide full SWIFT messages for input to the SWIFT network.

Nevertheless, there is nothing prohibiting an application to directly use this class for whatever purpose.

Given reasonable parameter values in the constructor, the string() method in this class will return an Application Header Block (Block nbr 2) that can be used in a SWIFT message sent to the SWIFT network.

CONSTRUCTOR

new( MESSAGE_TYPE=>300, BIC=>VALIDBIC, TERMINAL=>X, BRANCH_CODE=>XXX, MESSAGE_PRIORITY=>N, DELIVERY_MONITORING=>1, OBSOLESCENCE_PERIOD=> )

The parameters may be given in arbitrary order. Many parameters have builtin default values. If the calling application doesnt provide the parameter at all, the object will apply the default value.

MESSAGE_TYPE=>

Technically optional, but its hard to see a reason not to provide this parameter.
A numeric scalar value that indicates the message type being provided. For an MT300 message, use the value 300. For an MT515, use 515. Etc.

BIC=>

An eight character scalar value that contains a valid receiver BIC.
The receiver BIC is technically optional, but it will probably quite rarely make sense to instantiate an object of this class without specifying a BIC.

TERMINAL=>

Optional. A one character scalar value that identifies the receiving terminal.
Default value: X. It is very unusual that the sending party would populate this entity with anything else than the default value. It is thereby recommended that most applications dont provide this parameter at all.

BRANCH_CODE=>

Optional. A three character scalar value that identifies the branch code at the receiver.

Default value: XXX.

MESSAGE_PRIORITY=>

Optional. A one character scalar value indicating the requested network priority for the message.

If given, use one of the values:

SWIFT::Factory::ApplicationHeader::MSG_PRIORITY_SYSTEM();
SWIFT::Factory::ApplicationHeader::MSG_PRIORITY_URGENT();
SWIFT::Factory::ApplicationHeader::MSG_PRIORITY_NORMAL();
Default value provided by the class:
SWIFT::Factory::ApplicationHeader::MSG_PRIORITY_NORMAL();

DELIVERY_MONITORING=>

Technically optional. SWIFT requires this entity for urgent messages. A one digit numeric scalar value or a zero length string.

If given, use one of the values:

SWIFT::Factory::ApplicationHeader::MONITORING_NON_DELIVERY();
SWIFT::Factory::ApplicationHeader::MONITORING_DELIVERY_NOTIFICATION();
SWIFT::Factory::ApplicationHeader::MONITORING_DELIVERY_BOTH();

Default value provided by the class: A zero length string which implies No monitoring.

OBSOLESCENCE_PERIOD=>

Optional. A numeric scalar value expressing the delay in units of 5 minutes. I.e. 3 means 15 minutes and 20 means 100 minutes.

Maximum three digits long. See the relevant SWIFT handbook for details.
Default value provided by the class: A zero length string which implies No obsolescence period.