SWIFT::Factory::Tag::Tag30V - Provide a TAG30V for a SWIFT message.


SWIFT-Factory-Tag-Tag30V documentation  | view source Contained in the SWIFT-Factory-Tag-Tag30V distribution.

Index


NAME

Top

SWIFT::Factory::Tag::Tag30V - Provide a TAG30V for a SWIFT message.

SYNOPSIS

Top

  use SWIFT::Factory::Tag::Tag30V;
  my $tag30V = SWIFT::Factory::Tag::Tag30V->new( YEAR=>2003, MONTH=>2, DAY=>17 );

DESCRIPTION

Top

Tag 30V is used to provide the Value Date in a SWIFT message.

This class is derived from SWIFT::Factory::Tag::Tag30 and the reader is strongly encouraged to read the documentation for that class as well.

CONSTRUCTOR

Top

new( YEAR=>2003, MONTH=>2, DAY=>17 );

Instantiates a new Tag30V object.

The parameters may be given in arbitrary order. All parameters have built-in default values. If the calling application doesn't provide a specific parameter at all, the object will apply the default value to that parameter. Beware that the default values may be invalid in a SWIFT message.

YEAR=>

Technically optional but logically required. Default value: 0 (zero). Beware that the default value is invalid in a SWIFT message.

A numeric scalar value that will be part of the value date in TAG30V.

MONTH=>

Technically optional but logically required. Default value: 0 (zero). Beware that the default value is invalid in a SWIFT message.

A numeric scalar value that will be part of the value date in TAG30V. Valid values are 1 - 12, inclusive.

DAY=>

Technically optional but logically required. Default value: 0 (zero). Beware that the default value is invalid in a SWIFT message.

A numeric scalar value that will be part of the value date in TAG30V. Valid values are 1 - 31, inclusive.

PUBLIC CLASS METHODS

Top

Class methods are always called with the fully qualified name, like:

 print SWIFT::Factory::Tag::Tag30V::VERSION();

(The new() constructor is a typical example of a class method.)

VERSION()

Will return the version of this Perl module. (This method is inherited from the UNIVERSAL class.)

TAG_ID()

It is very unlikeley that the calling application will benefit from calling this method. The method is providing the Tag ID which is the difference between a TAG30 and a TAG30V. By providing this method in this class, the equivalent method in the base class is overridden and a TAG30V is provided by string() instead of a TAG30.

FIGURES_IN_YEAR();

The method provides an important difference between the base class and Tag30V, namely the number of figures allowed in the YEAR=> in the constructor.

PUBLIC OBJECT METHODS

Top

borken()

A really broken alias for invalid(). Will execute exactly the same code as the invalid() method.

invalid()

Will return the number of errors detected in the objects instance data.

The class can never be charged to guarrantee that the provided string() will be fully compliant with the SWIFT standards or SWIFT verification rules. It can only point out known problems in the object as it is currently loaded.

BETA

Please beware that the current implementation of invalid() doesn't check anything at all. Consider it a placeholder for now. When time permits, the method will be filled with validation code.

Return value:

As it stands, the method will always return zero since it wasn't able to discover any error at all.

provide()

An alias for string(). Will execute exactly the same code as the string() method.

string()

Will return a fully formatted string containing a TAG30V for a SWIFT message.

AUTHOR

Top

Gustav Schaffter, <schaffter_cpan@hotmail.com>

COPYRIGHT

Top

SEE ALSO

Top

Other Perl modules implementing SWIFT tags in the SWIFT::Factory::Tag::Tagnn family.

Appropriate SWIFT documentation.


SWIFT-Factory-Tag-Tag30V documentation  | view source Contained in the SWIFT-Factory-Tag-Tag30V distribution.