summaryrefslogtreecommitdiff
path: root/site_perl/svc_acct_pop.pm
blob: a6f801f22f91518501aca70292af282c346f27c7 (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
162
163
package FS::svc_acct_pop;

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

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

=head1 NAME

FS::svc_acct_pop - Object methods for svc_acct_pop records

=head1 SYNOPSIS

  use FS::svc_acct_pop;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::svc_acct object represents an point of presence.  FS::svc_acct_pop
inherits from FS::Record.  The following fields are currently supported:

=over 4

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

=item city

=item state

=item ac - area code

=item exch - exchange

=back

=head1 METHODS

=over 4

=item create 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 create {
  my($proto,$hashref)=@_;

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

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

=item insert

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

=cut

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

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

=item delete

Currently unimplemented.

=cut

sub delete {
  my($self)=@_;
  return "Can't (yet) delete POPs!";
  #$self->del;
}

=item replace OLD_RECORD

Replaces 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 an svc_acct_pop record!"
    unless $old->table eq "svc_acct_pop";
  return "Can't change popnum!"
    unless $old->getfield('popnum') eq $new->getfield('popnum');
  $new->check or
  $new->rep($old);
}

=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)=@_;
  return "Not a svc_acct_pop record!" unless $self->table eq "svc_acct_pop";

  my($error)=
    $self->ut_numbern('popnum')
      or $self->ut_text('city')
      or $self->ut_text('state')
      or $self->ut_number('ac')
      or $self->ut_number('exch')
  ;
  return $error if $error;

  '';

}

=back

=head1 BUGS

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

It should be renamed to part_pop.

=head1 SEE ALSO

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

=head1 HISTORY

Class dealing with pops 

ivan@sisd.com 98-mar-8 

pod ivan@sisd.com 98-sep-23

=cut

1;