NAME

SWIFT::Factory::Tag::Tag17A - Provides the TAG17A for a SWIFT message.

SYNOPSIS

use SWIFT::Factory::Tag::Tag17A;
my $tag17A = SWIFT::Factory::Tag::Tag17A->new();

DESCRIPTION

TAG17A is used as a Buy (Sell) Indicator.

If the payload data in TAG17A holds a true value, then this is a Buy transaction.

If the payload data in TAG17A holds a false value, then this is a Sell transaction.

CONSTRUCTOR

new( INDICATOR=>1 );

Instantiates a new Tag17A object.

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::Tag17A->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 overrides the class method with the same name in the SWIFT::Factory::Tag::Tag17 class and gives the unique identifier for the Tag17A class.

INDICATOR_TRUE()

This method is probably never called by an application.

The method is inherited from the class method with the same name in the SWIFT::Factory::Tag::Tag17 class and 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 inherited from the class method with the same name in the SWIFT::Factory::Tag::Tag17 class and 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 TAG17A 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

The SWIFT::Factory::Tag::Tag17 class.

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

Appropriate SWIFT documentation.