summaryrefslogtreecommitdiff
path: root/FS/FS/part_fee_msgcat.pm
blob: e60651e0e3f5da7694c3339ed5e7dd061a749ed5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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<FS::part_fee>)

=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<hash> 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<FS::Record>, schema.html from the base documentation.

=cut

1;