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
|
package FS::fiber_olt;
use base qw( FS::Record );
use strict;
use FS::Record qw( qsearch qsearchs );
use FS::olt_site;
=head1 NAME
FS::fiber_olt - Object methods for fiber_olt records
=head1 SYNOPSIS
use FS::fiber_olt;
$record = new FS::fiber_olt \%hash;
$record = new FS::fiber_olt { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::fiber_olt object represents an Optical Line Terminal that fiber
connections (L<FS::svc_fiber>) connect to. FS::fiber_olt inherits from
FS::Record. The following fields are currently supported:
=over 4
=item oltnum - primary key
=item oltname - name of this device
=item serial - serial number
=item sitenum - the L<FS::olt_site> where this OLT is installed
=item disabled - set to 'Y' to make this OLT unavailable for new connections
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new fiber_olt record. To add it to the database, see L<"insert">.
=cut
# the new method can be inherited from FS::Record, if a table method is defined
sub table { 'fiber_olt'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=item delete
Delete this record from the database.
=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.
=item check
Checks all fields to make sure this is a valid example. If there is
an error, returns the error, otherwise returns false. Called by the insert
and replace methods.
=cut
# the check method should currently be supplied - FS::Record contains some
# data checking routines
sub check {
my $self = shift;
my $error =
$self->ut_numbern('oltnum')
|| $self->ut_text('oltname')
|| $self->ut_text('serial')
|| $self->ut_foreign_keyn('sitenum', 'olt_site', 'sitenum')
|| $self->ut_flag('disabled')
;
return $error if $error;
$self->SUPER::check;
}
=item site_description
Returns the OLT's site description.
=cut
sub site_description {
my $self = shift;
return '' if !$self->sitenum;
my $olt_site = FS::olt_site->by_key($self->sitenum);
return $olt_site->description;
}
=item description
Returns the OLT's site name and unit name.
=cut
sub description {
my $self = shift;
my $desc = $self->oltname;
$desc = $self->site_description . '/' . $desc if $self->sitenum;
return $desc;
}
=back
=head1 SEE ALSO
L<FS::svc_fiber>, L<FS::olt_site>, L<FS::Record>
=cut
1;
|
