FS/FS/quotation.pm

   1 package FS::quotation;
   2 use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin FS::Record );
   3
   4 use strict;
   5 use FS::Record qw( qsearch qsearchs );
   6 use FS::CurrentUser;
   7 use FS::cust_main;
   8 use FS::prospect_main;
   9 use FS::quotation_pkg;
  10
  11 =head1 NAME
  12
  13 FS::quotation - Object methods for quotation records
  14
  15 =head1 SYNOPSIS
  16
  17   use FS::quotation;
  18
  19   $record = new FS::quotation \%hash;
  20   $record = new FS::quotation { 'column' => 'value' };
  21
  22   $error = $record->insert;
  23
  24   $error = $new_record->replace($old_record);
  25
  26   $error = $record->delete;
  27
  28   $error = $record->check;
  29
  30 =head1 DESCRIPTION
  31
  32 An FS::quotation object represents a quotation.  FS::quotation inherits from
  33 FS::Record.  The following fields are currently supported:
  34
  35 =over 4
  36
  37 =item quotationnum
  38
  39 primary key
  40
  41 =item prospectnum
  42
  43 prospectnum
  44
  45 =item custnum
  46
  47 custnum
  48
  49 =item _date
  50
  51 _date
  52
  53 =item disabled
  54
  55 disabled
  56
  57 =item usernum
  58
  59 usernum
  60
  61
  62 =back
  63
  64 =head1 METHODS
  65
  66 =over 4
  67
  68 =item new HASHREF
  69
  70 Creates a new quotation.  To add the quotation to the database, see L<"insert">.
  71
  72 Note that this stores the hash reference, not a distinct copy of the hash it
  73 points to.  You can ask the object for a copy with the I<hash> method.
  74
  75 =cut
  76
  77 sub table { 'quotation'; }
  78 sub notice_name { 'Quotation'; }
  79 sub template_conf { 'quotation_'; }
  80
  81 =item insert
  82
  83 Adds this record to the database.  If there is an error, returns the error,
  84 otherwise returns false.
  85
  86 =item delete
  87
  88 Delete this record from the database.
  89
  90 =item replace OLD_RECORD
  91
  92 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  93 returns the error, otherwise returns false.
  94
  95 =item check
  96
  97 Checks all fields to make sure this is a valid quotation.  If there is
  98 an error, returns the error, otherwise returns false.  Called by the insert
  99 and replace methods.
 100
 101 =cut
 102
 103 sub check {
 104   my $self = shift;
 105
 106   my $error =
 107     $self->ut_numbern('quotationnum')
 108     || $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum' )
 109     || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum' )
 110     || $self->ut_numbern('_date')
 111     || $self->ut_enum('disabled', [ '', 'Y' ])
 112     || $self->ut_numbern('usernum')
 113   ;
 114   return $error if $error;
 115
 116   $self->_date(time) unless $self->_date;
 117
 118   $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
 119
 120   $self->SUPER::check;
 121 }
 122
 123 =item prospect_main
 124
 125 =cut
 126
 127 sub prospect_main {
 128   my $self = shift;
 129   qsearchs('prospect_main', { 'prospectnum' => $self->prospectnum } );
 130 }
 131
 132 =item cust_main
 133
 134 =cut
 135
 136 sub cust_main {
 137   my $self = shift;
 138   qsearchs('cust_main', { 'custnum' => $self->custnum } );
 139 }
 140
 141 =item cust_bill_pkg
 142
 143 =cut
 144
 145 sub cust_bill_pkg {
 146   my $self = shift;
 147   #actually quotation_pkg objects
 148   qsearch('quotation_pkg', { quotationnum=>$self->quotationnum });
 149 }
 150
 151 =back
 152
 153 =item enable_previous
 154
 155 =cut
 156
 157 sub enable_previous { 0 }
 158
 159 =head1 BUGS
 160
 161 =head1 SEE ALSO
 162
 163 L<FS::Record>, schema.html from the base documentation.
 164
 165 =cut
 166
 167 1;
 168