Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

lire::reportjob(3pm) [debian man page]

ReportJob(3pm)						  LogReport's Lire Documentation					    ReportJob(3pm)

NAME

       Lire::ReportJob - Object used to configure periodical report generation

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.

   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.

SEE ALSO

       Lire::DlfStore(3pm) Lire::ImportJob(3pm) Lire::ReportSchedule(3pm) lire(1) Lire::OutputJob(3pm)

AUTHOR

	 Francis J. Lacoste <flacoste@logreport.org>

VERSION

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

COPYRIGHT

       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.

Lire 2.1.1							    2006-07-23							    ReportJob(3pm)

Check Out this Related Man Page

Param(3pm)						  LogReport's Lire Documentation						Param(3pm)

NAME

       Lire::Param - Object which represents a parameter in a XML specification.

DESCRIPTION

       Lire::Param are objects which represent parameters in an XML specification. The object is used to represent the parameter's specification
       as well as its current value.

   new( 'name' => $name, 'type' => $type, [ 'default' => $default ] )
       Creates a new Lire::Param object.

   name()
       Returns the name of this parameter.

   type()
       Returns this parameter's type.

   value( [ $new_value ] )
       Returns (and optionnally modifies) the current value for this parameter. If no value was set, but a default is available, the default value
       will be returned.

   default( [ $new_default ] )
       Returns (and optionnally changes) the parameter's default value.

   description( [ $new_description ] )
       Returns (and optionnally changes) the current parameter's description.

   as_type_spec()
       Returns a Lire::Config::TypeSpec object which adequately represents the current parameter.

SEE ALSO

	 Lire::Config::TypeSpec(3pm), Lire::XMLSpecContainer(3pm)

AUTHOR

	 Francis J. Lacoste <flacoste@logreport.org>

VERSION

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

COPYRIGHT

       Copyright (C) 2001,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.

Lire 2.1.1							    2006-07-23								Param(3pm)
Man Page