.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "RoPkg::Simba::Mirror 3pm"
.TH RoPkg::Simba::Mirror 3pm "2006-07-04" "perl v5.14.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::Mirror \- a mirror class
.SH "VERSION"
.IX Header "VERSION"
0.1.3
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
RoPkg::Simba::Mirror is a class used to hold all the information
a mirror has. Also, the RoPkg::Simba::Mirror can be used to 
add/del/update a mirror to/from the database. Simba is derivated
from \fIRoPkg::DBObject\fR.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& !#/usr/bin/perl
\& 
\& use RoPkg::DB;
\& use RoPkg::Simba::Mirror;
\& 
\& sub main {
\&   my $dbp = new RoPkg::DB();
\&   $dbp\->Add(\*(Aqdbi:mysql:database=mysql;host=localhost\*(Aq,
\&             \*(Aqroot\*(Aq,
\&             \*(Aq\*(Aq,
\&             \*(Aqlocal\*(Aq);
\&
\&   my $m = new RoPkg::Simba::Mirror(dbo => $dbp, dbo_method => \*(Aqdb_local\*(Aq);
\&   $m\->Name(\*(Aqdebian\*(Aq);
\&   $m\->Load();
\& }
\& 
\& main();
.Ve
.SH "SUBROUTINES/METHODS"
.IX Header "SUBROUTINES/METHODS"
All methods raise OutsideClass exception when called outside
class instance. Besides this, each method, may raise other
exceptions. Check each method section to find out more.
.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 mirrors database table.
.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 mirror from the database. Before
calling this method, you should set the \fBid\fR of the
mirror . 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 mirror object with the database. Before
calling this method, you should set the \fBid\fR of the
mirror . 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 mirror information from the database, into
the current object. Before calling this method
you should have set \fBid\fR or \fBName\fR. If id or
Name are not set, then Param::Missing is raised.
On database operation success 0 is returned. On
database error, \s-1DBI\s0 exception is raised.
.SS "\fIGetMethods()\fP"
.IX Subsection "GetMethods()"
Returns a array with the current object methods
names. In scalar context returns the number
of methods.
.PP
The following methods are get/set methods for
all fields of a mirror.
.IP "*) id" 24
.IX Item "*) id"
.PD 0
.IP "*) Name" 24
.IX Item "*) Name"
.IP "*) Description" 24
.IX Item "*) Description"
.IP "*) HomeSite" 24
.IX Item "*) HomeSite"
.IP "*) LocalDir" 24
.IX Item "*) LocalDir"
.IP "*) Size" 24
.IX Item "*) Size"
.IP "*) SyncMethod" 24
.IX Item "*) SyncMethod"
.IP "*) CommandID" 24
.IX Item "*) CommandID"
.IP "*) LastErrorCode" 24
.IX Item "*) LastErrorCode"
.IP "*) Active" 24
.IX Item "*) Active"
.IP "*) InProgress" 24
.IX Item "*) InProgress"
.IP "*) SyncSource" 24
.IX Item "*) SyncSource"
.IP "*) SyncSourceUser" 24
.IX Item "*) SyncSourceUser"
.IP "*) SyncSourcePass" 24
.IX Item "*) SyncSourcePass"
.IP "*) SyncSourceModule" 24
.IX Item "*) SyncSourceModule"
.IP "*) Contact" 24
.IX Item "*) Contact"
.IP "*) LastUpdated" 24
.IX Item "*) LastUpdated"
.IP "*) LastUpdateDuration" 24
.IX Item "*) LastUpdateDuration"
.IP "*) LastUpdateSpeed" 24
.IX Item "*) LastUpdateSpeed"
.IP "*) LastUpdateFilesNo" 24
.IX Item "*) LastUpdateFilesNo"
.IP "*) LastUpdateBytes" 24
.IX Item "*) LastUpdateBytes"
.IP "*) LocalURL" 24
.IX Item "*) LocalURL"
.IP "*) StdOut" 24
.IX Item "*) StdOut"
.IP "*) StdErr" 24
.IX Item "*) StdErr"
.PD
.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 RoPkg::Simba::Mirrors RoPkg::DBObject 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.