Lire::ReportSection(3pm)

Lire::ReportSection3pm

Api to report configuration's section

Usage

    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 );

Overview

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.

Version

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

Releases

5 releases since Debian 4.0 (Etch); the text changed 4 times.

  1. 4.0
  2. 5.0
  3. 6.0
  4. 7
  5. Arch

Author

  Francis J. Lacoste <[email protected]>

From lire 2.1.1-8 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.