Lire::ReportJob3pm
Object used to configure periodical report generation
Usage
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' );
Overview
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.
new( $name, );
Create a new Lire::ReportJob(). The constructor takes one parameter which is an identifier.
name()
Returns the name of this ReportJob.
add_schedule( $schedule, ... )
Adds one or more Lire::ReportSchedule to the ReportJob objects.
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 OutputJob associated with the ScheduleJob will have been sent. The $time parameter will be used to determine the time window covered by period. It defaults to the current time.
Version
$Id: ReportJob.pm,v 1.9 2006/07/23 13:16:29 vanbaal Exp $
Releases
6 releases since Debian 3.1 (Sarge); the text changed 5 times.