debian man page for ropkg::simba::command

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

NAME
       RoPkg::Simba::Command

VERSION
       0.1.2

DESCRIPTION
       RoPkg::Simba::Command is the class used by simba to manipulate a command. It has the basic sql methods (inherited from RoPkg::DBObject).

SYNOPSIS
	!#/usr/bin/perl

	use RoPkg::DB;
	use RoPkg::Simba::Command;

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

	  my $c = new RoPkg::Simba::Command(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 commands database table.

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

       *) id
       *) Path
       *) Args

   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 command from the database. Before calling this method, you should set the id of the command . 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 command object with the database. Before calling this method, you should set the id of the command . 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 command from the database, into the current object. Before calling this method you should have set id. If id or is not set, then
       Param::Missing is raised.  On database operation success 0 is returned. On database error, DBI exception is raised.

DIAGNOSTICS
       This module comes with his own tests. To run the tests, unpack the source, and use 'make test' commmand

CONFIGURATION AND ENVIRONMENT
       This module doesn't use configuration files and environment variables.

DEPENDENCIES
       RoPkg::DBObject and RoPkg::Exceptions

INCOMPATIBILITIES
       None known to the author

BUGS AND LIMITATIONS
       None known to the author

PERL CRITIC
       The code is perl critic level 2 compliant (with one exception)

SEE ALSO
       RoPkg::Simba::Commands 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::Command(3pm)