FS/FS/part_fee_msgcat.pm

   1 package FS::part_fee_msgcat;
   2 use base qw( FS::Record );
   3
   4 use strict;
   5 use FS::Locales;
   6
   7 =head1 NAME
   8
   9 FS::part_fee_msgcat - Object methods for part_fee_msgcat records
  10
  11 =head1 SYNOPSIS
  12
  13   use FS::part_fee_msgcat;
  14
  15   $record = new FS::part_fee_msgcat \%hash;
  16   $record = new FS::part_fee_msgcat { 'column' => 'value' };
  17
  18   $error = $record->insert;
  19
  20   $error = $new_record->replace($old_record);
  21
  22   $error = $record->delete;
  23
  24   $error = $record->check;
  25
  26 =head1 DESCRIPTION
  27
  28 An FS::part_fee_msgcat object represents localized labels of a fee
  29 definition.  FS::part_fee_msgcat inherits from FS::Record.  The following
  30 fields are currently supported:
  31
  32 =over 4
  33
  34 =item feepartmsgnum
  35
  36 primary key
  37
  38 =item feepart - Fee definition (L<FS::part_fee>)
  39
  40 =item locale - locale string
  41
  42 =item itemdesc - Localized fee name (customer-viewable)
  43
  44 =item comment - Localized fee comment (non-customer-viewable), optional
  45
  46 =back
  47
  48 =head1 METHODS
  49
  50 =over 4
  51
  52 =item new HASHREF
  53
  54 Creates a new record.  To add the record to the database, see L<"insert">.
  55
  56 Note that this stores the hash reference, not a distinct copy of the hash it
  57 points to.  You can ask the object for a copy with the I<hash> method.
  58
  59 =cut
  60
  61 # the new method can be inherited from FS::Record, if a table method is defined
  62
  63 sub table { 'part_fee_msgcat'; }
  64
  65 =item insert
  66
  67 Adds this record to the database.  If there is an error, returns the error,
  68 otherwise returns false.
  69
  70 =cut
  71
  72 # the insert method can be inherited from FS::Record
  73
  74 =item delete
  75
  76 Delete this record from the database.
  77
  78 =cut
  79
  80 # the delete method can be inherited from FS::Record
  81
  82 =item replace OLD_RECORD
  83
  84 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  85 returns the error, otherwise returns false.
  86
  87 =cut
  88
  89 # the replace method can be inherited from FS::Record
  90
  91 =item check
  92
  93 Checks all fields to make sure this is a valid record.  If there is
  94 an error, returns the error, otherwise returns false.  Called by the insert
  95 and replace methods.
  96
  97 =cut
  98
  99 sub check {
 100   my $self = shift;
 101
 102   my $error =
 103     $self->ut_numbern('feepartmsgnum')
 104     || $self->ut_foreign_key('feepart', 'part_fee', 'feepart')
 105     || $self->ut_enum('locale', [ FS::Locales->locales ] )
 106     || $self->ut_text('itemdesc')
 107     || $self->ut_textn('comment')
 108   ;
 109   return $error if $error;
 110
 111   $self->SUPER::check;
 112 }
 113
 114 =back
 115
 116 =head1 BUGS
 117
 118 Exactly duplicates part_pkg_msgcat.pm.
 119
 120 =head1 SEE ALSO
 121
 122 L<FS::Record>, schema.html from the base documentation.
 123
 124 =cut
 125
 126 1;
 127