.\" -*- 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 "ReportSchedule 3pm"
.TH ReportSchedule 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::ReportSchedule \- Object which reprents one 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( \*(Aqdaily_www_report\*(Aq );
\&  $job\->add_schedule( new Lire::ReportSchedule( \*(Aqdaily\*(Aq, $cfg );
\&  $job\->run( \*(Aqdaily\*(Aq, $store );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Lire::ReportSchedule objects together with Lire::OutputJob objects
make it possible to configure all kind of periodical report
generation. Whereas the Lire::OutputJob is used to represent the
formatting of one generated report, the Lire::ReportSchedule
represents such a generation. It will be use to generate periodically
one XML report in a DlfStore using one report configuration file.
.PP
ReportSchedules grouped together in one ReportJob are assumed to
generate compatible reports as far as merging is concerned. The idea
is that previous reports generated in one ReportJob (according to
different schedules) could be used as a data source when the DlfStore
doesn\*(Aqt contain all the DLF records for the whole period. For example,
if you don\*(Aqt keep one year of www DLF in your store, you could still
generate an yearly report using the daily reports generated during the
year.
.ie n .SS "new( $period, $cfg );"
.el .SS "new( \f(CW$period\fP, \f(CW$cfg\fP );"
.IX Subsection "new( $period, $cfg );"
Creates a new Lire::ReportSchedule that will generates an XML report
using the Lire::ReportConfig \f(CW$cfg\fR on a \f(CW$period\fR period.
\&\f(CW$period\fR should be one of \*(Aqhourly\*(Aq, \*(Aqdaily\*(Aq, \*(Aqweekly\*(Aq, \*(Aqmonthly\*(Aq or
\&\*(Aqyearly\*(Aq.
.SS \fBperiod()\fP
.IX Subsection "period()"
Returns the period of this ReportSchedule.
.ie n .SS "period_range( [ $time ] )"
.el .SS "period_range( [ \f(CW$time\fP ] )"
.IX Subsection "period_range( [ $time ] )"
Returns the starting and ending boundaries of the schedule period
which includes \f(CW$time\fR. (Defaults to now). The ending boundary is
excluded from the period and the starting boundary is included.
.ie n .SS "report_config( [ $new_cfg ] )"
.el .SS "report_config( [ \f(CW$new_cfg\fP ] )"
.IX Subsection "report_config( [ $new_cfg ] )"
Returns (and optionally change) the Lire::ReportConfig object to
use for this schedule.
.ie n .SS "init_report_config( [ $time ] )"
.el .SS "init_report_config( [ \f(CW$time\fP ] )"
.IX Subsection "init_report_config( [ $time ] )"
Returns the Lire::ReportConfig object with filters set. A FilterSpec
will have been added to each section of the ReportConfig object which
will restrict the reporting on the period defined for the scedule. The
boundaries of the period are determined according to \f(CW$time\fR which
defaults to now.
.ie n .SS "add_output_jobs( $job, ... )"
.el .SS "add_output_jobs( \f(CW$job\fP, ... )"
.IX Subsection "add_output_jobs( $job, ... )"
Adds one or more Lire::OutputJob to the ReportSchedule object.
.SS \fBoutput_jobs()\fP
.IX Subsection "output_jobs()"
Returns the Lire::OutputJobs related to this object.
.ie n .SS "run( $store, $report_job, [$time]  )"
.el .SS "run( \f(CW$store\fP, \f(CW$report_job\fP, [$time]  )"
.IX Subsection "run( $store, $report_job, [$time] )"
Generate a XML report and save it in the \f(CW$store\fR Lire::DlfStore. The
report will be generated either using the DlfStreams or previously
generated reports. Preferences is giving to generating the report
using the Dlf data For more details, consult the documentation
of \fBfind_report_source()\fR in \fBLire::DlfStore\fR\|(3pm).
.PP
The period for which the report will be generated is done using the
\&\f(CW$time\fR parameter which defaults to now. For example, a \*(Aqdaily\*(Aq report
will generate a report for the whole day (midnight\-midnidht based on
the day that \f(CW$time\fR represents).
.PP
Once the report is generated, all registered OutputJob will be run
with the new report.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::DlfStore\fR\|(3pm) \fBLire::DlfConverter\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 ReportSchedule.pm,v 1.17 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.