summaryrefslogtreecommitdiff
path: root/FS/FS/part_pop_local.pm
blob: 01c59df93f9c0fdcf826fdba5e619b23bd735b71 (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
package FS::part_pop_local;

use strict;
use vars qw( @ISA );
use FS::Record; # qw( qsearchs );

@ISA = qw( FS::Record );

=head1 NAME

FS::part_pop_local - Object methods for part_pop_local records

=head1 SYNOPSIS

  use FS::part_pop_local;

  $record = new FS::part_pop_local \%hash;
  $record = new FS::part_pop_local { 'column' => 'value' };

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::part_pop_local object represents a local call area.  Each
FS::part_pop_local record maps a NPA/NXX (area code and exchange) to the POP
(see L<FS::svc_acct_pop>) which is a local call.  FS::part_pop_local inherits
from FS::Record.  The following fields are currently supported:

=over 4

=item localnum - primary key (assigned automatically for new accounts)

=item popnum - see L<FS::svc_acct_pop>

=item city

=item state

=item npa - area code

=item nxx - exchange

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new point of presence (if only it were that easy!).  To add the 
point of presence to the database, see L<"insert">.

=cut

sub table { 'part_pop_local'; }

=item insert

Adds this point of presence to the database.  If there is an error, returns the
error, otherwise returns false.

=item delete

Removes this point of presence from the database.

=item replace OLD_RECORD

Replaces OLD_RECORD with this one in the database.  If there is an error,
returns the error, otherwise returns false.

=item check

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

=cut

sub check {
  my $self = shift;

    $self->ut_numbern('localnum')
      or $self->ut_numbern('popnum')
      or $self->ut_text('city')
      or $self->ut_text('state')
      or $self->ut_number('npa')
      or $self->ut_number('nxx')
      or $self->SUPER::check
  ;

}

=back

=head1 BUGS

US/CA-centric.

=head1 SEE ALSO

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

=cut

1;