.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "OutputJob 3pm"
.TH OutputJob 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire 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
Lire::OutputJob \- Object used to represent a configured formatting of a report
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  use Lire::OutputJob;
\&  use Lire::OutputFormat;
\&
\&  my $email = new Lire::OutputJob( \*(Aqemail\*(Aq, $output, $output_cfg,
\&                                   \*(Aqemails\*(Aq => [ \*(Aqemail@domain.org\*(Aq ] );
\&
\&  $email\->run( \*(Aqreport.xml\*(Aq );
\&
\&  my $file = new Lire::OutputJob( \*(Aqfile\*(Aq, $output, $output_cfg,
\&                                  \*(Aqfilename\*(Aq => \*(Aq/var/www/reports/daily\-%Y%m%d\*(Aq  );
\&  $file\->run( \*(Aqreport.xml\*(Aq );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The Lire::OutputJob objects are used to represent how a report should
formatted. These objects are most often created from the Lire
configuration. (The \*(Aqoutput_jobs\*(Aq specification.)
.ie n .SH "new( $destination_type, $format, $format_cfg, ... );"
.el .SH "new( \f(CW$destination_type\fP, \f(CW$format\fP, \f(CW$format_cfg\fP, ... );"
.IX Header "new( $destination_type, $format, $format_cfg, ... );"
Create a new Lire::OutputJob object. Two parameters are required:
.ie n .IP $destination_type 4
.el .IP \f(CW$destination_type\fR 4
.IX Item "$destination_type"
Can be either \*(Aqemail\*(Aq or \*(Aqfile\*(Aq.
.ie n .IP $format 4
.el .IP \f(CW$format\fR 4
.IX Item "$format"
A Lire::OutputFormat object.
.ie n .IP $format 4
.el .IP \f(CW$format\fR 4
.IX Item "$format"
The configuration data that will be passed to the OutputFormat
object.
.PP
The method will returns an instance of Lire::EmailOutputJob or
Lire::FileOutputJob.
.SS format
.IX Subsection "format"
Returns the Lire::OutputFormat associated with this OutputJob.
.SS format_cfg
.IX Subsection "format_cfg"
Returns the configuration data that will be used when formatting the
report.
.ie n .SS "run( $report_file )"
.el .SS "run( \f(CW$report_file\fP )"
.IX Subsection "run( $report_file )"
Formats and sends or save the XML report \f(CW$report_file\fR according the
OutputJob parameters.
.SH Lire::EmailOutputJob
.IX Header "Lire::EmailOutputJob"
.SS "Extra parameters for \*(Aqemail\*(Aq type"
.IX Subsection "Extra parameters for 'email' type"
.IP emails 4
.IX Item "emails"
An array reference to the emails that will receive the formatted report.
.IP subjet 4
.IX Item "subjet"
The subject of the email.
.IP extra_file 4
.IX Item "extra_file"
An additional text file that will be appended to text report or attach
to other report types.
.SS \fBemails()\fP
.IX Subsection "emails()"
Returns as an array the emails to which the report will be sent.
.SS \fBsubject()\fP
.IX Subsection "subject()"
Returns the subject of the email.
.SS \fBextra_file()\fP
.IX Subsection "extra_file()"
Returns the filename that will be appended to the text report or
attach to the message for other report\*(Aqs type.
.SH Lire::FileOutputJob
.IX Header "Lire::FileOutputJob"
.SS "Extra parameters for \*(Aqfile\*(Aq type."
.IX Subsection "Extra parameters for 'file' type."
.IP file 4
.IX Item "file"
A file path with possible \fBstrftime\fR\|(3pm) interpolation. This will be
were the formatted report will be saved.
.SS \fBfile()\fP
.IX Subsection "file()"
Returns this OutputJob destination file.
.SS "output_file( [$time] )"
.IX Subsection "output_file( [$time] )"
Returns the  destination file with \fBstrftime\fR\|(3) specifier interpolated.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::ReportJob\fR\|(3pm) \fBLire::OutputFormat\fR\|(3pm)
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR OutputJob.pm,v 1.8 2006/07/23 13:16:29 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.