23 Feb 2003 17:12:41 UTC
- Distribution: SWIFT-Factory-Tag-Tag20
- Module version: 0.01
- Source (raw)
- Browse (raw)
- How to Contribute
- Testers (421 / 0 / 0)
- KwaliteeBus factor: 0
- 35.29% Coverage
- License: unknown
- Activity24 month
- Download (3.43KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionSCHAFFTER Gustav Schaffter
- PUBLIC CLASS METHODS
- PUBLIC OBJECT METHODS
- SEE ALSO
SWIFT::Factory::Tag::Tag20 - Provide a TAG20 for a SWIFT message.
use SWIFT::Factory::Tag::Tag20; my $tag20 = SWIFT::Factory::Tag::Tag20->new( DO_CLEANUP=>0, REFERENCE=>'SOME_REF' );
Tag 20 is used to provide the Senders Reference in a SWIFT message. It is up to the sending party to make sure the reference is unambigous.
Instantiates a new Tag20 object.
The parameters may be given in arbitrary order. Both 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.
Optional. Default value: false
If given with a true value, the object will try to cleanup some of the parameters given. For instance, if
REFERENCE=>is too long, the Tag20 object will truncate it.
If not given, or if given with a false value, it is fully up to the calling application to assure that the given parameters contain reasonable values.
A scalar value that can be used to uniquely identify the message at the sender side. May not be longer than SWIFT::Factory::Tag::Tag20::REF_MAX_LEN.
DO_CLEANUP=>was given a true value, then the value given in
REFERENCE=>will be truncated if it is too long.
Class methods are always called with the fully qualified name, like:
(The new() constructor is a typical example of a class method.)
Returns the maximum length allowed for the Reference in a TAG20. See also the ref_max_len() object method.
A really broken alias for invalid(). Will execute exactly the same code as the invalid() method.
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.
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.
As it stands, the method will always return zero since it wasn't able to discover any error at all.
An alias for string(). Will execute exactly the same code as the string() method.
Returns the maximum length allowed for the Reference in a TAG20. See also the REF_MAX_LEN() class method.
Get and/or set the Senders Reference that will be used when providing the TAG20 string.
Takes one optional parameter, a scalar containing a new Senders Reference that will be used in all subsequent method calls for this object.
If a Senders Reference is provided, it will be stored for future use.
Will return a fully formatted string containing a TAG20 for a SWIFT message.
Will return the version of this Perl module. (This method is inherited from the UNIVERSAL class.)
Gustav Schaffter, <email@example.com>
Copyright (c) 2003, Gustav Schaffter. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Other Perl modules implementing SWIFT tags in the SWIFT::Factory::Tag::Tagnn family.
Appropriate SWIFT documentation.
1 POD Error
The following errors were encountered while parsing the POD:
- Around line 124:
You can't have =items (as at line 133) unless the first thing after the =over is an =item
Module Install Instructions
To install SWIFT::Factory::Tag::Tag20, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install SWIFT::Factory::Tag::Tag20
For more information on module installation, please visit the detailed CPAN module installation guide.