summaryrefslogtreecommitdiff
path: root/FS/FS/part_device.pm
blob: ac987400a7ac237db886cdbfced1168742a11d31 (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
164
165
166
167
168
169
170
package FS::part_device;

use strict;
use base qw( FS::Record FS::m2m_Common );
use FS::Record qw( qsearch qsearchs );
use FS::part_export;
use FS::export_device;

=head1 NAME

FS::part_device - Object methods for part_device records

=head1 SYNOPSIS

  use FS::part_device;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::part_device object represents a phone device definition. FS::part_device
inherits from FS::Record.  The following fields are currently supported:

=over 4

=item devicepart

primary key

=item devicename

device name (used in Freeside)

=item inventory_classnum

L<FS::inventory_class> used to track inventory of these devices.

=item title

external device name (for export)

=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 { 'part_device'; }

=item insert

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

=cut

# the insert method can be inherited from FS::Record

=item delete

Delete this record from the database.

=cut

# the delete method can be inherited from FS::Record

=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

# the replace method can be inherited from FS::Record

=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('devicepart')
    || $self->ut_text('devicename')
    || $self->ut_foreign_keyn('inventory_classnum', 'inventory_class', 'classnum')
    || $self->ut_textn('title')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=item part_export

Returns a list of all exports (see L<FS::part_export>) for this device.

=cut

sub part_export {
  my $self = shift;
  map { qsearchs( 'part_export', { 'exportnum' => $_->exportnum } ) }
    qsearch( 'export_device', { 'devicepart' => $self->devicepart } );
}

=item inventory_class

Returns the inventory class (see L<FS::inventory_class>) for this device, 
if any.

=cut

sub inventory_class {
  my $self = shift;
  return '' unless $self->inventory_classnum;
  qsearchs('inventory_class', { 'classnum' => $self->inventory_classnum });
}

sub process_batch_import {
  my $job = shift;

  my $opt = { 'table'   => 'part_device',
              'params'  => [],
              'formats' => { 'default' => [ 'devicename' ] },
              'default_csv' => 1,
            };

  FS::Record::process_batch_import( $job, $opt, @_ );

}

=back

=head1 BUGS

=head1 SEE ALSO

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

=cut

1;