summaryrefslogtreecommitdiff
path: root/site_perl/cust_main_county.pm
blob: f4b4595aefe61ee4b12680d4660919fcf5b17ced (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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
package FS::cust_main_county;

use strict;
use vars qw(@ISA @EXPORT_OK);
use Exporter;
use FS::Record qw(fields hfields qsearch qsearchs);

@ISA = qw(FS::Record Exporter);
@EXPORT_OK = qw(hfields);

=head1 NAME

FS::cust_main_county - Object methods for cust_main_county objects

=head1 SYNOPSIS

  use FS::cust_main_county;

  $record = create FS::cust_main_county \%hash;
  $record = create FS::cust_main_county { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::cust_main_county object represents a tax rate, defined by locale.
FS::cust_main_county inherits from FS::Record.  The following fields are
currently supported:

=over 4

=item taxnum - primary key (assigned automatically for new tax rates)

=item state

=item county

=item tax - percentage

=back

=head1 METHODS

=over 4

=item create HASHREF

Creates a new tax rate.  To add the tax rate to the database, see L<"insert">.

=cut

sub create {
  my($proto,$hashref)=@_;

  #now in FS::Record::new
  #my($field);
  #foreach $field (fields('cust_main_county')) {
  #  $hashref->{$field}='' unless defined $hashref->{$field};
  #}

  $proto->new('cust_main_county',$hashref);
}

=item insert

Adds this tax rate to the database.  If there is an error, returns the error,
otherwise returns false.

=cut

sub insert {
  my($self)=@_;

  $self->check or
  $self->add;
}

=item delete

Deletes this tax rate from the database.  If there is an error, returns the
error, otherwise returns false.

=cut

sub delete {
  my($self)=@_;

  $self->del;
}

=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

sub replace {
  my($new,$old)=@_;
  return "(Old) Not a cust_main_county record!"
    unless $old->table eq "cust_main_county";
  return "Can't change taxnum!"
    unless $old->getfield('taxnum') eq $new->getfield('taxnum');
  $new->check or
  $new->rep($old);
}

=item check

Checks all fields to make sure this is a valid tax rate.  If there is an error,
returns the error, otherwise returns false.  Called by the insert and replace
methods.

=cut

sub check {
  my($self)=@_;
  return "Not a cust_main_county record!"
    unless $self->table eq "cust_main_county";
  my($recref) = $self->hashref;

  $self->ut_numbern('taxnum')
    or $self->ut_text('state')
    or $self->ut_textn('county')
    or $self->ut_float('tax')
  ;

}

=back

=head1 BUGS

It doesn't properly override FS::Record yet.

A country field (and possibly a currency field) should be added.

=head1 SEE ALSO

L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill>, schema.html from the base
documentation.

=head1 HISTORY

ivan@voicenet.com 97-dec-16

Changed check for 'tax' to use the new ut_float subroutine
	bmccane@maxbaud.net	98-apr-3

pod ivan@sisd.com 98-sep-21

=cut

1;