quotations, RT#16996
authorIvan Kohler <ivan@freeside.biz>
Mon, 2 Jul 2012 21:23:05 +0000 (14:23 -0700)
committerIvan Kohler <ivan@freeside.biz>
Mon, 2 Jul 2012 21:23:05 +0000 (14:23 -0700)
FS/FS/quotation.pm [new file with mode: 0644]

diff --git a/FS/FS/quotation.pm b/FS/FS/quotation.pm
new file mode 100644 (file)
index 0000000..4202335
--- /dev/null
@@ -0,0 +1,148 @@
+package FS::quotation;
+
+use strict;
+use base qw( FS::otaker_Mixin FS::Record );
+use FS::Record; # qw( qsearch qsearchs );
+use FS::cust_main;
+use FS::prospect_main;
+
+=head1 NAME
+
+FS::quotation - Object methods for quotation records
+
+=head1 SYNOPSIS
+
+  use FS::quotation;
+
+  $record = new FS::quotation \%hash;
+  $record = new FS::quotation { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::quotation object represents a quotation.  FS::quotation inherits from
+FS::Record.  The following fields are currently supported:
+
+=over 4
+
+=item quotationnum
+
+primary key
+
+=item prospectnum
+
+prospectnum
+
+=item custnum
+
+custnum
+
+=item _date
+
+_date
+
+=item disabled
+
+disabled
+
+=item usernum
+
+usernum
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new quotation.  To add the quotation 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 { 'quotation'; }
+
+=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 quotation.  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('quotationnum')
+    || $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum' )
+    || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum' )
+    || $self->ut_numbern('_date')
+    || $self->ut_enum('disabled', [ '', 'Y' ])
+    || $self->ut_numbern('usernum')
+  ;
+  return $error if $error;
+
+  $self->_date(time) unless $self->_date;
+
+  #XXX set usernum
+
+  $self->SUPER::check;
+}
+
+=item prospect_main
+
+=cut
+
+sub prospect_main {
+  my $self = shift;
+  qsearchs('prospect_main', { 'prospectnum' => $self->prospectnum } );
+}
+
+=item cust_main
+
+=cut
+
+sub cust_main {
+  my $self = shift;
+  qsearchs('cust_main', { 'custnum' => $self->custnum } );
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+