summaryrefslogtreecommitdiff
path: root/FS/FS/ac.pm
blob: 5a2b360791684424401db90db9eff42af716813a (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
package FS::ac;

use strict;
use vars qw( @ISA );
use FS::Record qw( qsearchs qsearch );
use FS::ac_type;
use FS::ac_block;

@ISA = qw( FS::Record );

=head1 NAME

FS::ac - Object methods for ac records

=head1 SYNOPSIS

  use FS::ac;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::ac record describes a broadband Access Concentrator, such as a DSLAM
or a wireless access point.  FS::ac inherits from FS::Record.  The following 
fields are currently supported:

narf

=over 4

=item acnum - primary key

=item actypenum - AC type, see L<FS::ac_type>

=item acname - descriptive name for the AC

=back

=head1 METHODS

=over 4

=item new HASHREF

Create a new record.  To add the record to the database, see L<"insert">.

=cut

sub table { 'ac'; }

=item insert

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

=item delete

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

=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 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('acnum')
    || $self->ut_number('actypenum')
    || $self->ut_text('acname');
  return $error if $error;

  return "Unknown actypenum"
    unless $self->ac_type;
  '';
}

=item ac_type

Returns the L<FS::ac_type> object corresponding to this object.

=cut

sub ac_type {
  my $self = shift;
  return qsearchs('ac_type', { actypenum => $self->actypenum });
}

=item ac_block

Returns a list of L<FS::ac_block> objects (address blocks) associated
with this object.

=cut

sub ac_block {
  my $self = shift;
  return qsearch('ac_block', { acnum => $self->acnum });
}

=item ac_field

Returns a hash of L<FS::ac_field> objects assigned to this object.

=cut

sub ac_field {
  my $self = shift;

  return qsearch('ac_field', { acnum => $self->acnum });
}

=back

=head1 VERSION

$Id:

=head1 BUGS

=head1 SEE ALSO

L<FS::svc_broadband>, L<FS::ac>, L<FS::ac_block>, L<FS::ac_field>,  schema.html
from the base documentation.

=cut

1;