X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_fee_msgcat.pm;fp=FS%2FFS%2Fpart_fee_msgcat.pm;h=e60651e0e3f5da7694c3339ed5e7dd061a749ed5;hb=30e2dfd524a3f52445cbca6bc2cd1962dce7eb04;hp=0000000000000000000000000000000000000000;hpb=3c7fd3e7d40f2c946b2fcf63c63d595c82fcae22;p=freeside.git diff --git a/FS/FS/part_fee_msgcat.pm b/FS/FS/part_fee_msgcat.pm new file mode 100644 index 000000000..e60651e0e --- /dev/null +++ b/FS/FS/part_fee_msgcat.pm @@ -0,0 +1,127 @@ +package FS::part_fee_msgcat; +use base qw( FS::Record ); + +use strict; +use FS::Locales; + +=head1 NAME + +FS::part_fee_msgcat - Object methods for part_fee_msgcat records + +=head1 SYNOPSIS + + use FS::part_fee_msgcat; + + $record = new FS::part_fee_msgcat \%hash; + $record = new FS::part_fee_msgcat { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +=head1 DESCRIPTION + +An FS::part_fee_msgcat object represents localized labels of a fee +definition. FS::part_fee_msgcat inherits from FS::Record. The following +fields are currently supported: + +=over 4 + +=item feepartmsgnum + +primary key + +=item feepart - Fee definition (L) + +=item locale - locale string + +=item itemdesc - Localized fee name (customer-viewable) + +=item comment - Localized fee comment (non-customer-viewable), optional + +=back + +=head1 METHODS + +=over 4 + +=item new HASHREF + +Creates a new record. 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 method. + +=cut + +# the new method can be inherited from FS::Record, if a table method is defined + +sub table { 'part_fee_msgcat'; } + +=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 record. 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('feepartmsgnum') + || $self->ut_foreign_key('feepart', 'part_fee', 'feepart') + || $self->ut_enum('locale', [ FS::Locales->locales ] ) + || $self->ut_text('itemdesc') + || $self->ut_textn('comment') + ; + return $error if $error; + + $self->SUPER::check; +} + +=back + +=head1 BUGS + +Exactly duplicates part_pkg_msgcat.pm. + +=head1 SEE ALSO + +L, schema.html from the base documentation. + +=cut + +1; +