FS/FS/quotation_pkg_discount.pm

   1 package FS::quotation_pkg_discount;
   2
   3 use strict;
   4 use base qw( FS::Record );
   5 use FS::Record qw( qsearch qsearchs );
   6 use FS::Maketext 'mt';
   7
   8 =head1 NAME
   9
  10 FS::quotation_pkg_discount - Object methods for quotation_pkg_discount records
  11
  12 =head1 SYNOPSIS
  13
  14   use FS::quotation_pkg_discount;
  15
  16   $record = new FS::quotation_pkg_discount \%hash;
  17   $record = new FS::quotation_pkg_discount { 'column' => 'value' };
  18
  19   $error = $record->insert;
  20
  21   $error = $new_record->replace($old_record);
  22
  23   $error = $record->delete;
  24
  25   $error = $record->check;
  26
  27 =head1 DESCRIPTION
  28
  29 An FS::quotation_pkg_discount object represents a quotation package discount.
  30 FS::quotation_pkg_discount inherits from FS::Record.  The following fields are
  31 currently supported:
  32
  33 =over 4
  34
  35 =item quotationpkgdiscountnum
  36
  37 primary key
  38
  39 =item quotationpkgnum
  40
  41 quotationpkgnum of the L<FS::quotation_pkg> record that this discount is
  42 for.
  43
  44 =item discountnum
  45
  46 discountnum (L<FS::discount>)
  47
  48 =item setup_amount
  49
  50 Amount that will be discounted from setup fees, per package quantity.
  51
  52 =item recur_amount
  53
  54 Amount that will be discounted from recurring fees in the first billing
  55 cycle, per package quantity.
  56
  57 =back
  58
  59 =head1 METHODS
  60
  61 =over 4
  62
  63 =item new HASHREF
  64
  65 Creates a new quotation package discount.  To add the quotation package
  66 discount to the database, see L<"insert">.
  67
  68 Note that this stores the hash reference, not a distinct copy of the hash it
  69 points to.  You can ask the object for a copy with the I<hash> method.
  70
  71 =cut
  72
  73 # the new method can be inherited from FS::Record, if a table method is defined
  74
  75 sub table { 'quotation_pkg_discount'; }
  76
  77 =item insert
  78
  79 Adds this record to the database.  If there is an error, returns the error,
  80 otherwise returns false.
  81
  82 =cut
  83
  84 # the insert method can be inherited from FS::Record
  85
  86 =item delete
  87
  88 Delete this record from the database.
  89
  90 =cut
  91
  92 # the delete method can be inherited from FS::Record
  93
  94 =item replace OLD_RECORD
  95
  96 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  97 returns the error, otherwise returns false.
  98
  99 =cut
 100
 101 # the replace method can be inherited from FS::Record
 102
 103 =item check
 104
 105 Checks all fields to make sure this is a valid quotation package discount.
 106 If there is an error, returns the error, otherwise returns false.
 107 Called by the insert and replace methods.
 108
 109 =cut
 110
 111 # the check method should currently be supplied - FS::Record contains some
 112 # data checking routines
 113
 114 sub check {
 115   my $self = shift;
 116
 117   my $error =
 118     $self->ut_numbern('quotationpkgdiscountnum')
 119     || $self->ut_foreign_key('quotationpkgnum', 'quotation_pkg', 'quotationpkgnum' )
 120     || $self->ut_foreign_key('discountnum', 'discount', 'discountnum' )
 121     || $self->ut_moneyn('setup_amount')
 122     || $self->ut_moneyn('recur_amount')
 123   ;
 124   return $error if $error;
 125
 126   $self->SUPER::check;
 127 }
 128
 129 =back
 130
 131 =item amount
 132
 133 Returns the total amount of this discount (setup + recur), for compatibility
 134 with L<FS::cust_bill_pkg_discount>.
 135
 136 =cut
 137
 138 sub amount {
 139   my $self = shift;
 140   return $self->get('setup_amount') + $self->get('recur_amount');
 141 }
 142
 143 =item description
 144
 145 Returns a string describing the discount (for use on the quotation).
 146
 147 =cut
 148
 149 sub description {
 150   my $self = shift;
 151   my $discount = $self->discount;
 152   my $desc = $discount->description_short;
 153   # XXX localize to prospect language, once prospects get languages
 154   $desc .= mt(' each') if $self->quotation_pkg->quantity > 1;
 155
 156   if ($discount->months) {
 157     # unlike cust_bill_pkg_discount, there are no "months remaining"; it
 158     # hasn't started yet.
 159     $desc .= mt(' (for [quant,_1,month])', $discount->months);
 160   }
 161   return $desc;
 162 }
 163
 164 =head1 BUGS
 165
 166 =head1 SEE ALSO
 167
 168 L<FS::Record>, schema.html from the base documentation.
 169
 170 =cut
 171
 172 1;
 173