RoPkg::Simba::Exclude(3pm)				User Contributed Perl Documentation				RoPkg::Simba::Exclude(3pm)

NAME

       RoPkg::Simba::Exclude

VERSION

       0.1.2

DESCRIPTION

       RoPkg::Simba::Exclude is the class used by simba to manipulate a exclude list. It has the basic sql methods (inherited from
       RoPkg::DBObject).

SYNOPSIS

	!#/usr/bin/perl

	use RoPkg::DB;
	use RoPkg::Simba::Exclude;

	sub main {
	  my $dbp = new RoPkg::DB();
	  $dbp->Add('dbi:mysql:database=mysql;host=localhost',
		    'root',
		    '',
		    'local');

	  my $c = new RoPkg::Simba::Exclude(db => $dbp, db_method => 'db_local');
	  $c->id(1);
	  $c->Load();
	}

	main();

SUBROUTINES
/METHODS
       All methods (besides new) raise OutsideClass exception when called outside class instance. Also, some methods may rise diferent exceptions.
       Please read the section in which the method is described to find out more information about exceptions.

   new()
       The class constructor. At this moment, it just calls RoPkg::DBObject->new() . Please read the RoPkg::DBObject manual page for more
       information about the new() parameters.

   table()
       Returns the name of the exclude lists database table.

   ExList()
       get/set the excluded items. When set behaviour is selected, the exclude list must be passed to the method. The exclude list must be set
       before adding the new exclude list to database.

   AddItems(@new_items)
       Add @new_items to the list of excluded items and returns the new number of excluded items.

   GetItems()
       Returns the list of excluded items. In scalar context returns the number of excluded items

       The following methods are get/set methods for all fields of a mirror.

       *) id
       *) MirrorID
       *) CommandID

   Add()
       Adds the mirror to the database. This method is a wrapper for RoPkg::DBObject::SQL_Insert . On success 0 is returned. On error, DBI
       exception is raised.

   Delete()
       Deletes the current exclude list from the database. Before calling this method, you should set the id of the exclude list . If you don't
       set the id Param::Missing exception is raised. On database operation success, 0 is returned. On database error, DBI exception is raised.

   Update()
       Update the current exclude list object with the database. Before calling this method, you should set the id of the exclude list . If you
       don't set the id Param::Missing exception is raised. On database operation success, 0 is returned. On database error, DBI exception is
       raised.

   Load()
       Load the exclude list from the database, into the current object. Before calling this method you should have set id or MirrorID and
       CommandID.  If none are found, then Param::Missing is raised.  On database operation success 0 is returned. On database error, DBI
       exception is raised.

DIAGNOSTICS

       Unpack the source, and use 'make test' command

CONFIGURATION AND ENVIRONMENT

       This module does not use any configuration files or environment variables.

DEPENDENCIES

       RoPkg::DBObject and RoPkg::Exceptions

INCOMPATIBILITIES

       None known to the author

BUGS AND LIMITATIONS

       None known to the author

PERL CRITIC

       This module is perl critic level 2 compliant (with 1 exception)

SEE ALSO

       RoPkg::Simba::Excludes RoPkg::Exceptions RoPkg::Object

AUTHOR

       Subredu Manuel <diablo@iasi.roedu.net>

LICENSE AND COPYRIGHT

       Copyright (C) 2005 Subredu Manuel.  All Rights Reserved.  This module is free software; you can redistribute it and/or modify it under the
       same terms as Perl itself.  The LICENSE file contains the full text of the license.

perl v5.14.2							    2006-07-04						RoPkg::Simba::Exclude(3pm)