trusty (3) Lire::Config::XMLSpecListSpec.3pm.gz

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

NAME

       Lire::Config::XMLSpecListSpec - List of XML specifications.

DESCRIPTION

       This Lire::Config::TypeSpec defines a special kind of ListSpec. It overrides the has_component(), get(),
       component_names() and components() methods so that every XML report specifications or filter
       specifications are available. The specifications are created dynamically at runtime.

   new( 'name' => $name, 'type' => 'filters'|'reports )
       Creates a new Lire::Config::XMLSpecListSpec object which will contains a list of report or filter
       specifications configuration. The type parameter is used to select whether Lire::ReportSpec or
       Lire::FilterSpec will be creatd.

   type()
       Returns the type of specification contained by this object.

   has_component( $name )
       This spec will return true when $name is of the form superservice:id and there is an available id
       specification defined in superservice. It returns false otherwise.

   component_names()
       Returns an array containing the configuration name of all available specifications.

   get( $name )
       Returns an Lire::Config::ObjectSpec specification for the component named $name. The ObjectSpec will
       instantiate a Lire::ReportSpec or Lire::FilterSpec of the appropriate type.

   components()
       Returns an array containing all the Lire::Config::ObjectSpec defining the available specifications.

   SEE ALSO
         Lire::Config::ReportSectionSpec(3pm), Lire::Config::ReportSpec(3pm),
         Lire::ReportSpec(3pm), Lire::FilterSpec(3pm).

VERSION

       $Id: XMLSpecListSpec.pm,v 1.8 2006/07/23 13:16:31 vanbaal Exp $

AUTHOR

         Francis J. Lacoste <flacoste@logreport.org>

       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.