Frank Dupont > SWIFT-Factory-Tag-Tag17-0.01 > SWIFT::Factory::Tag::Tag17

Download:
SWIFT-Factory-Tag-Tag17-0.01.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.01   Source  

NAME ^

SWIFT::Factory::Tag::Tag17 - Provides a base class for the TAG17x for a SWIFT message.

SYNOPSIS ^

  use SWIFT::Factory::Tag::Tag17;
  my $tag17 = SWIFT::Factory::Tag::Tag17->new();

DESCRIPTION ^

This class provides a a base class for the TAG17x family of classes.

The class is primarily used as a base class for other TAG17x classes, for instance TAG17T and TAG17U.

CONSTRUCTOR ^

new( INDICATOR=>1 );

Instantiates a new Tag17 object.

It is still unclear to the author if there exists a clean TAG17 holding a boolean type of value.

If you use this class to directly instantiate a clean TAG17, then please contact me so that I can take appropriate action.

INDICATOR=>

Optional scalar value. Default value: false

If given with any true value, the object will provide a Yes or logically True value in the string() method.

If omitted, or given with a false value, the object will provide a No or logically False value in the string() method.

PUBLIC CLASS METHODS ^

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

 print SWIFT::Factory::Tag::Tag17->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()

This method is probably never called by an application.

The method is primarily provided to be overridden by classes inheriting from SWIFT::Factory::Tag::Tag17, like for instance TAG17T and TAG17U.

The TAG17 class returns nothing but a zero length string.

INDICATOR_TRUE()

This method is probably never called by an application.

The method is primarily provided to be overridden by classes inheriting from SWIFT::Factory::Tag::Tag17, like for instance TAG17T and TAG17U.

Returns a scalar value with the logically True boolean value stored in the object.

INDICATOR_FALSE()

This method is probably never called by an application.

The method is primarily provided to be overridden by classes inheriting from SWIFT::Factory::Tag::Tag17, like for instance TAG17T and TAG17U.

Returns a scalar value with the logically False boolean value stored in the object.

PUBLIC OBJECT METHODS ^

provide()

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

string()

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

AUTHOR ^

BIKER, <biker_cpan@hotmail.com>

COPYRIGHT ^

Copyright (c) 2003, BIKER. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO ^

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

Appropriate SWIFT documentation.

syntax highlighting: