.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\" ========================================================================
.\"
.IX Title "RoPkg::Simba::Exclude 3pm"
.TH RoPkg::Simba::Exclude 3pm "2016-08-21" "perl v5.22.2" "User Contributed Perl 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"
RoPkg::Simba::Exclude
.SH "VERSION"
.IX Header "VERSION"
0.1.2
.SH "DESCRIPTION"
.IX Header "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).
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& !#/usr/bin/perl
\& 
\& use RoPkg::DB;
\& use RoPkg::Simba::Exclude;
\& 
\& sub main {
\&   my $dbp = new RoPkg::DB();
\&   $dbp\->Add(\*(Aqdbi:mysql:database=mysql;host=localhost\*(Aq,
\&             \*(Aqroot\*(Aq,
\&             \*(Aq\*(Aq,
\&             \*(Aqlocal\*(Aq);
\&
\&   my $c = new RoPkg::Simba::Exclude(db => $dbp, db_method => \*(Aqdb_local\*(Aq);
\&   $c\->id(1);
\&   $c\->Load();
\& }
\& 
\& main();
.Ve
.SH "SUBROUTINES/METHODS"
.IX Header "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.
.SS "\fInew()\fP"
.IX Subsection "new()"
The class constructor. At this moment, it just calls
RoPkg::DBObject\->\fInew()\fR . Please read the RoPkg::DBObject
manual page for more information about the \fInew()\fR parameters.
.SS "\fItable()\fP"
.IX Subsection "table()"
Returns the name of the exclude lists database table.
.SS "\fIExList()\fP"
.IX Subsection "ExList()"
get/set the excluded items. When set behaviour is selected, the exclude
list must be passed to the method. The exclude list \fBmust\fR be set
before adding the new exclude list to database.
.SS "AddItems(@new_items)"
.IX Subsection "AddItems(@new_items)"
Add \f(CW@new_items\fR to the list of excluded items and returns
the new number of excluded items.
.SS "\fIGetItems()\fP"
.IX Subsection "GetItems()"
Returns the list of excluded items. In scalar context
returns the number of excluded items
.PP
The following methods are get/set methods for
all fields of a mirror.
.IP "*) id" 3
.IX Item "*) id"
.PD 0
.IP "*) MirrorID" 3
.IX Item "*) MirrorID"
.IP "*) CommandID" 3
.IX Item "*) CommandID"
.PD
.SS "\fIAdd()\fP"
.IX Subsection "Add()"
Adds the mirror to the database. This method is a
wrapper for RoPkg::DBObject::SQL_Insert . On success
0 is returned. On error, \s-1DBI\s0 exception is raised.
.SS "\fIDelete()\fP"
.IX Subsection "Delete()"
Deletes the current exclude list from the database. Before
calling this method, you should set the \fBid\fR of the
exclude list . If you don't set the \fBid\fR Param::Missing 
exception is raised. On database operation success,
0 is returned. On database error, \s-1DBI\s0 exception is
raised.
.SS "\fIUpdate()\fP"
.IX Subsection "Update()"
Update the current exclude list object with the database. Before
calling this method, you should set the \fBid\fR of the
exclude list . If you don't set the \fBid\fR Param::Missing 
exception is raised. On database operation success,
0 is returned. On database error, \s-1DBI\s0 exception is
raised.
.SS "\fILoad()\fP"
.IX Subsection "Load()"
Load the exclude list from the database, into
the current object. Before calling this method
you should have set \fBid\fR or \fBMirrorID\fR and \fBCommandID\fR.
If none are found, then Param::Missing is raised.
On database operation success 0 is returned. On
database error, \s-1DBI\s0 exception is raised.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
Unpack the source, and use 'make test' command
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
This module does not use any configuration files or environment
variables.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
RoPkg::DBObject and RoPkg::Exceptions
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
None known to the author
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
None known to the author
.SH "PERL CRITIC"
.IX Header "PERL CRITIC"
This module is perl critic level 2 compliant (with 1 exception)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
RoPkg::Simba::Excludes RoPkg::Exceptions RoPkg::Object
.SH "AUTHOR"
.IX Header "AUTHOR"
Subredu Manuel <diablo@iasi.roedu.net>
.SH "LICENSE AND COPYRIGHT"
.IX Header "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 \s-1LICENSE\s0 file contains the full text of the license.