ReportJob(3pm)

📦 version 2.1.1, in arch rolling

💖 ReportJob(3pm) 💖

🌸 NAME 🌸

Lire::ReportJob — object used to configure periodical report generation. (Yep, this is from LogReport's Lire Documentation, bestie.)

✨ SYNOPSIS ✨

use Lire::ReportJob;
use Lire::ReportSchedule;

my $store = Lire::DlfStore->open( 'aStore' );
my $job = new Lire::ReportJob( "webServer" );
my $cfg = $store->get_report_config( 'my_report' );
$job->add_schedule( new Lire::ReportSchedule( 'daily', $cfg );
$job->run( $store, 'daily' );

🦋 DESCRIPTION 🦋

The Lire::ReportJob object is used to configure and execute report generation jobs. These objects are usually configured in a store through the lire(1) command. It’s giving “set it up once, then let it run its little periodical-report era.” 💅

🎀 new( $name, );

Creates a new Lire::ReportJob(). The constructor takes one parameter, and that parameter is an identifier. One identifier, no extra drama. ✨

🎀 name()

Returns the name of this ReportJob. Name check: passed. 🫶

🎀 add_schedule( $schedule, ... )

Adds one or more Lire::ReportSchedule to the ReportJob objects. Bring your schedules, bestie — more than one is allowed. 🌸

🎀 schedules()

Returns the Lire::ReportSchedule related to this object. 🌈

🎀 run( $store, $period, [$time] )

Executes all the configured generation with a period of 'period' using the $store DlfStore. Once the method returns, XML report will have been generated in the DlfStore and the OutputJob associated with the ScheduleJob will have been sent.

The $time parameter is used to determine the time window covered by period. It defaults to the current time. No cap, it just uses now unless you tell it otherwise. ⏰

👑 SEE ALSO 👑

💜 AUTHOR 💜

Francis J. Lacoste <flacoste@logreport.org> — iconic. 🌟

🎀 VERSION 🎀

$Id: ReportJob.pm,v 1.9 2006/07/23 13:16:29 vanbaal Exp $

Copyright (C) 2004 Stichting LogReport Foundation LogReport@LogReport.org

This file is part of Lire.

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.

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.

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.

Signing off from Lire 2.1.1, dated 2025-09-28 — that’s the footer, bestie; now go generate those reports 💅✨

📦 where this page comes from