.\" -*- 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 "ReportJob 3pm"
.TH ReportJob 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::ReportJob \- Object used to configure periodical report generation
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  use Lire::ReportJob;
\&  use Lire::ReportSchedule;
\&
\&  my $store = Lire::DlfStore\->open( \*(AqaStore\*(Aq );
\&  my $job = new Lire::ReportJob( "webServer" );
\&  my $cfg = $store\->get_report_config( \*(Aqmy_report\*(Aq );
\&  $job\->add_schedule( new Lire::ReportSchedule( \*(Aqdaily\*(Aq, $cfg );
\&  $job\->run( $store, \*(Aqdaily\*(Aq );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The Lire::ReportJob object is used to configure and execute report
generation jobs. These objects are usually configured in a store
through the \fBlire\fR\|(1) command.
.ie n .SS "new( $name, );"
.el .SS "new( \f(CW$name\fP, );"
.IX Subsection "new( $name, );"
Create a new \fBLire::ReportJob()\fR. The constructor takes one parameter
which is an identifier.
.SS \fBname()\fP
.IX Subsection "name()"
Returns the name of this ReportJob.
.ie n .SS "add_schedule( $schedule, ... )"
.el .SS "add_schedule( \f(CW$schedule\fP, ... )"
.IX Subsection "add_schedule( $schedule, ... )"
Adds one or more Lire::ReportSchedule to the ReportJob objects.
.SS \fBschedules()\fP
.IX Subsection "schedules()"
Returns the Lire::ReportSchedule related to this object.
.ie n .SS "run( $store, $period, [$time]  )"
.el .SS "run( \f(CW$store\fP, \f(CW$period\fP, [$time]  )"
.IX Subsection "run( $store, $period, [$time] )"
Executes all the configured generation with a period of \*(Aqperiod\*(Aq using
the \f(CW$store\fR DlfStore. Once the method returns, XML report will have
been generated in the DlfStore and OutputJob associated with the
ScheduleJob will have been sent. The \f(CW$time\fR parameter will be used to
determine the time window covered by period. It defaults to the
current time.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::DlfStore\fR\|(3pm) \fBLire::ImportJob\fR\|(3pm) \fBLire::ReportSchedule\fR\|(3pm)
\&\fBlire\fR\|(1) \fBLire::OutputJob\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 ReportJob.pm,v 1.9 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.