summaryrefslogtreecommitdiff
path: root/FS/FS/export_nas.pm
blob: 3e5b841126de9d365bec9669822b9bccbf85d72a (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
package FS::export_nas;
use base qw( FS::Record );

use strict;
use vars qw($noexport_hack);

$noexport_hack = '';

=head1 NAME

FS::export_nas - Object methods for export_nas records

=head1 SYNOPSIS

  use FS::export_nas;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::export_nas object links RADIUS exports (in the part_export table)
to RADIUS clients (in the nas table).  FS::export_nas inherits from
FS::Record.  The following fields are currently supported:

=over 4

=item exportnasnum

primary key

=item exportnum

exportnum

=item nasnum

nasnum


=back

=head1 METHODS

=over 4

=item new HASHREF

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

Note that this stores the hash reference, not a distinct copy of the hash it
points to.  You can ask the object for a copy with the I<hash> method.

=cut

# the new method can be inherited from FS::Record, if a table method is defined

sub table { 'export_nas'; }

=item insert

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

=cut

sub insert {
  my $self = shift;
  $self->SUPER::insert || 
  ($noexport_hack ? '' : $self->part_export->export_nas_insert($self->nas));
}

=item delete

Delete this record from the database.

=cut

sub delete {
  my $self = shift;
  ($noexport_hack ? '' : $self->part_export->export_nas_delete($self->nas))
  || $self->SUPER::delete;
}

=item replace OLD_RECORD

Unavailable.  Delete the record and create a new one.

=cut

sub replace {
  die "replace not implemented for export_nas records";
}

=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

# the check method should currently be supplied - FS::Record contains some
# data checking routines

sub check {
  my $self = shift;

  my $error = 
    $self->ut_numbern('exportnasnum')
    || $self->ut_foreign_key('exportnum', 'part_export', 'exportnum' )
    || $self->ut_foreign_key('nasnum', 'nas', 'nasnum')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=back

=head1 BUGS

=head1 SEE ALSO

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

=cut

1;