diff options
author | ivan <ivan> | 2010-01-30 07:38:32 +0000 |
---|---|---|
committer | ivan <ivan> | 2010-01-30 07:38:32 +0000 |
commit | 0fcdc36642e1430f02ebf5326740e231883bd41f (patch) | |
tree | e5633883c65370134141202c40c616d35481d434 /FS/FS/cust_pkg_discount.pm | |
parent | 11b586f0fad8164514d272cee321e12bde6a49ef (diff) |
discounts, RT#6679
Diffstat (limited to 'FS/FS/cust_pkg_discount.pm')
-rw-r--r-- | FS/FS/cust_pkg_discount.pm | 145 |
1 files changed, 145 insertions, 0 deletions
diff --git a/FS/FS/cust_pkg_discount.pm b/FS/FS/cust_pkg_discount.pm new file mode 100644 index 0000000..76118ad --- /dev/null +++ b/FS/FS/cust_pkg_discount.pm @@ -0,0 +1,145 @@ +package FS::cust_pkg_discount; + +use strict; +use base qw( FS::Record ); +use FS::Record; # qw( qsearch qsearchs ); +use FS::cust_pkg; +use FS::discount; + +=head1 NAME + +FS::cust_pkg_discount - Object methods for cust_pkg_discount records + +=head1 SYNOPSIS + + use FS::cust_pkg_discount; + + $record = new FS::cust_pkg_discount \%hash; + $record = new FS::cust_pkg_discount { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +=head1 DESCRIPTION + +An FS::cust_pkg_discount object represents the application of a discount to a +customer package. FS::cust_pkg_discount inherits from FS::Record. The +following fields are currently supported: + +=over 4 + +=item pkgdiscountnum + +primary key + +=item pkgnum + +Customer package (see L<FS::cust_pkg>) + +=item discountnum + +Discount (see L<FS::discount>) + +=item months_used + +months_used + +=item end_date + +end_date + +=item otaker + +otaker + + +=back + +=head1 METHODS + +=over 4 + +=item new HASHREF + +Creates a new discount application. To add the record 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 + +# the new method can be inherited from FS::Record, if a table method is defined + +sub table { 'cust_pkg_discount'; } + +=item insert + +Adds this record to the database. If there is an error, returns the error, +otherwise returns false. + +=cut + +# the insert method can be inherited from FS::Record + +=item delete + +Delete this record from the database. + +=cut + +# the delete method can be inherited from FS::Record + +=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. + +=cut + +# the replace method can be inherited from FS::Record + +=item check + +Checks all fields to make sure this is a valid discount applciation. If there +is an error, returns the error, otherwise returns false. Called by the insert +and replace methods. + +=cut + +# the check method should currently be supplied - FS::Record contains some +# data checking routines + +sub check { + my $self = shift; + + my $error = + $self->ut_numbern('pkgdiscountnum') + || $self->ut_foreign_key('pkgnum', 'cust_pkg', 'pkgnum') + || $self->ut_foreign_key('discountnum', 'discount', 'discountnum' ) + || $self->ut_float('months_used') #actually decimal, but this will do + || $self->ut_numbern('end_date') + || $self->ut_text('otaker') + ; + return $error if $error; + + $self->SUPER::check; +} + +=back + +=head1 BUGS + +=head1 SEE ALSO + +L<FS::discount>, L<FS::cust_pkg>, L<FS::Record>, schema.html from the base documentation. + +=cut + +1; + |