Provided by: lire-devel-doc_2.1.1-2.1_all bug

NAME

       Lire::ReportSection - API to report configuration's section

SYNOPSIS

           use Lire::ReportConfig;
           use Lire::ReportSection;

           my $report_cfg = new Lire::ReportConfig( "www" );
           my $section = new Lire::ReportSection( "www", "General" );
           $report_cfg->add_section( $section );

DESCRIPTION

       This class offers an object oriented API to report configuration's section. It offers
       methods to access and modify the section's attribute.

CONSTRUCTOR

   new( $superservice, [$title] )
       Creates a new Lire::Section object which will contains report specifications of the
       $superservice superservice. The section's title will be set to the value of $title.

OBJECT METHODS

   superservice()
       Returns this section's superservice.

   title([$title])
       Return's the current section's title.

       When the $title parameter is used, it will set the section's title to a new value.

   filters()
       Returns this section's filter specifications as an array of Lire::FilterSpec objects.
       Those filter specifications will be used by all of this section's report specifications in
       addition to the filter specification they may already be using.

   add_filter($filter_spec)
       Adds the $filter_spec filter specification to this section's list. The $filter_spec
       parameter must be an instance of Lire::FilterSpec or one of its descendants.

       This method will die if the filter specification's schema isn't compatible with this
       section's superservice.

   reports()
       Returns this section's report specifications as an array of Lire::ReportSpec objects.

   add_report( $report_spec )
       Adds the $report_spec report specification to this section. This method will die if the
       report specification's schema isn't compatible with this section's superservice.

SEE ALSO

        Lire::ReportConfig(3pm), Lire::ReportSpec(3pm), Lire::FilterSpec(3pm)
        Lire::Report::Section(3pm), Lire::Config::ReportSectionSpec(3pm)

AUTHOR

         Francis J. Lacoste <flacoste@logreport.org>

VERSION

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

COPYRIGHT

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