simple A/P

[freeside.git] / FS / FS / vend_main.pm

diff --git a/FS/FS/vend_main.pm b/FS/FS/vend_main.pm
new file mode 100644 (file)
index 0000000..ef79c00
--- /dev/null
+++ b/FS/FS/vend_main.pm
@@ -0,0 +1,124 @@
+package FS::vend_main;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record qw( qsearchs ); # qsearch qsearchs );
+use FS::vend_class;
+
+=head1 NAME
+
+FS::vend_main - Object methods for vend_main records
+
+=head1 SYNOPSIS
+
+  use FS::vend_main;
+
+  $record = new FS::vend_main \%hash;
+  $record = new FS::vend_main { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::vend_main object represents a vendor.  FS::vend_main inherits from
+FS::Record.  The following fields are currently supported:
+
+=over 4
+
+=item vendnum
+
+primary key
+
+=item vendname
+
+vendname
+
+=item classnum
+
+classnum
+
+=item disabled
+
+disabled
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new vendor.  To add the vendor to the database, see L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to.  You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+sub table { 'vend_main'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=item delete
+
+Delete this record from the database.
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=item check
+
+Checks all fields to make sure this is a valid vendor.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and replace methods.
+
+=cut
+
+sub check {
+  my $self = shift;
+
+  my $error = 
+    $self->ut_numbern('vendnum')
+    || $self->ut_text('vendname')
+    || $self->ut_foreign_key('classnum', 'vend_class', 'classnum')
+    || $self->ut_enum('disabled', [ '', 'Y' ] )
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=item vend_class
+
+=cut
+
+sub vend_class {
+  my $self = shift;
+  qsearchs('vend_class', { 'classnum' => $self->classnum } );
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+