.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Business::Edifact::Message 3pm"
.TH Business::Edifact::Message 3pm "2021-01-02" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Business::Edifact::Message \- Class that models Edifact Messages
.SH "VERSION"
.IX Header "VERSION"
Version 0.07
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Parses an individual Edifact message
Message objects are instantiated by Business::Edifact::Interchange and an array
of them is returned in its messages function
   \f(CW$interchange\fR\->parse($incoming);
   my \f(CW$m_array\fR = \f(CW$interchange\fR\->\fBmessages()\fR;
   for my \f(CW$msg\fR (@{$m_array}) {
      ...retrieve message data
   }
.SH "SUBROUTINES/METHODS"
.IX Header "SUBROUTINES/METHODS"
.SS "new"
.IX Subsection "new"
Called by Business::Edifact::Interchange to instantiate a new Message
object. The caller passes the header fields with the 
reference number identifier and message type
.SS "add_segment"
.IX Subsection "add_segment"
Process the next data segment
.SS "type"
.IX Subsection "type"
return the message's type
e.g. '\s-1QUOTES\s0' or '\s-1ORDERS\s0'
.SS "function"
.IX Subsection "function"
Returns the message's function field
May be 'original' or 'retransmission'
.SS "message_code"
.IX Subsection "message_code"
Returns 3 character message code from the \s-1BGM\s0 message
.SS "currency_code"
.IX Subsection "currency_code"
.SS "reference_number"
.IX Subsection "reference_number"
.SS "date_of_message"
.IX Subsection "date_of_message"
.SS "items"
.IX Subsection "items"
return the list of lineitems
.SS "handle_bgm"
.IX Subsection "handle_bgm"
.SS "handle_dtm"
.IX Subsection "handle_dtm"
\&\s-1NB DTM\s0 can occur in different segment groups
.SS "handle_pat"
.IX Subsection "handle_pat"
.SS "handle_rff"
.IX Subsection "handle_rff"
.SS "handle_cux"
.IX Subsection "handle_cux"
.SS "handle_nad"
.IX Subsection "handle_nad"
.SS "handle_lin"
.IX Subsection "handle_lin"
.SS "handle_pia"
.IX Subsection "handle_pia"
.SS "handle_imd"
.IX Subsection "handle_imd"
.SS "handle_qty"
.IX Subsection "handle_qty"
.SS "handle_gir"
.IX Subsection "handle_gir"
.SS "handle_moa"
.IX Subsection "handle_moa"
.SS "handle_tax"
.IX Subsection "handle_tax"
.SS "handle_alc"
.IX Subsection "handle_alc"
.SS "handle_rte"
.IX Subsection "handle_rte"
.SS "handle_loc"
.IX Subsection "handle_loc"
.SS "handle_pri"
.IX Subsection "handle_pri"
.SS "handle_uns"
.IX Subsection "handle_uns"
.SS "handle_cnt"
.IX Subsection "handle_cnt"
.SS "handle_ftx"
.IX Subsection "handle_ftx"
.SS "handle_pcd"
.IX Subsection "handle_pcd"
.SS "clear_item_flags"
.IX Subsection "clear_item_flags"
.Vb 1
\& clear flags at start of new item or summary
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Colin Campbell, \f(CW\*(C`<colinsc@cpan.org>\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to \f(CW\*(C`bug\-edifact\-interchange at rt.cpan.org\*(C'\fR, or through
the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Business\-Edifact\-Interchange>.  I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc Business::Edifact::Message
.Ve
.SH "ACKNOWLEDGEMENTS"
.IX Header "ACKNOWLEDGEMENTS"
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright 2011\-2014 Colin Campbell.
.PP
This program is free software; you can redistribute it and/or modify it
under the terms of either: the \s-1GNU\s0 General Public License as published
by the Free Software Foundation; or the Artistic License.
.PP
See http://dev.perl.org/licenses/ for more information.