.\" -*- 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 "ReportSection 3pm"
.TH ReportSection 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::ReportSection \- API to report configuration\*(Aqs section
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    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 );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class offers an object oriented API to report configuration\*(Aqs
section. It offers methods to access and modify the section\*(Aqs
attribute.
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.ie n .SS "new( $superservice, [$title] )"
.el .SS "new( \f(CW$superservice\fP, [$title] )"
.IX Subsection "new( $superservice, [$title] )"
Creates a new Lire::Section object which will contains report
specifications of the \f(CW$superservice\fR superservice. The section\*(Aqs title
will be set to the value of \f(CW$title\fR.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.SS \fBsuperservice()\fP
.IX Subsection "superservice()"
Returns this section\*(Aqs superservice.
.SS title([$title])
.IX Subsection "title([$title])"
Return\*(Aqs the current section\*(Aqs title.
.PP
When the \f(CW$title\fR parameter is used, it will set the section\*(Aqs title to
a new value.
.SS \fBfilters()\fP
.IX Subsection "filters()"
Returns this section\*(Aqs filter specifications as an array of
Lire::FilterSpec objects. Those filter specifications will be used by
all of this section\*(Aqs report specifications in addition to the filter
specification they may already be using.
.SS add_filter($filter_spec)
.IX Subsection "add_filter($filter_spec)"
Adds the \f(CW$filter_spec\fR filter specification to this section\*(Aqs list. The
\&\f(CW$filter_spec\fR parameter must be an instance of Lire::FilterSpec or one
of its descendants.
.PP
This method will die if the filter specification\*(Aqs schema isn\*(Aqt
compatible with this section\*(Aqs superservice.
.SS \fBreports()\fP
.IX Subsection "reports()"
Returns this section\*(Aqs report specifications as an array of
Lire::ReportSpec objects.
.ie n .SS "add_report( $report_spec )"
.el .SS "add_report( \f(CW$report_spec\fP )"
.IX Subsection "add_report( $report_spec )"
Adds the \f(CW$report_spec\fR report specification to this section. This
method will die if the report specification\*(Aqs schema isn\*(Aqt compatible
with this section\*(Aqs superservice.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 2
\& Lire::ReportConfig(3pm), Lire::ReportSpec(3pm), Lire::FilterSpec(3pm)
\& Lire::Report::Section(3pm), Lire::Config::ReportSectionSpec(3pm)
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR ReportSection.pm,v 1.25 2006/07/23 13:16:29 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2002, 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.