summaryrefslogtreecommitdiff
path: root/FS/FS/export_device.pm
blob: 69e382649294674b69c9400b6d2d2629fe229f4c (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
package FS::export_device;

use strict;
use base qw( FS::Record );
use FS::Record qw( qsearch qsearchs dbh );
use FS::part_export;
use FS::part_device;

=head1 NAME

FS::export_device - Object methods for export_device records

=head1 SYNOPSIS

  use FS::export_device;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::export_device object links a device definition (see L<FS::part_device>)
to an export (see L<FS::part_export>).  FS::export_device inherits from
FS::Record.  The following fields are currently supported:

=over 4

=item exportdevicenum - primary key

=item exportnum - export (see L<FS::part_export>)

=item devicepart - device definition (see L<FS::part_device>)

=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

sub table { 'export_device'; }

=item insert

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

=cut

# may want to check for duplicates against either services or devices
# cf FS::export_svc

=item delete

Delete this record from the database.

=cut

=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.

=cut

=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;

  $self->ut_numbern('exportdevicenum')
    || $self->ut_number('exportnum')
    || $self->ut_foreign_key('exportnum', 'part_export', 'exportnum')
    || $self->ut_number('devicepart')
    || $self->ut_foreign_key('devicepart', 'part_device', 'devicepart')
    || $self->SUPER::check
  ;
}

=item part_export

Returns the FS::part_export object (see L<FS::part_export>).

=cut

sub part_export {
  my $self = shift;
  qsearchs( 'part_export', { 'exportnum' => $self->exportnum } );
}

=item part_device

Returns the FS::part_device object (see L<FS::part_device>).

=cut

sub part_device {
  my $self = shift;
  qsearchs( 'part_device', { 'svcpart' => $self->devicepart } );
}

=back

=head1 BUGS

=head1 SEE ALSO

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

=cut

1;