FS/FS/part_device.pm

   1 package FS::part_device;
   2
   3 use strict;
   4 use base qw( FS::Record FS::m2m_Common );
   5 use FS::Record qw( qsearch qsearchs );
   6 use FS::part_export;
   7 use FS::export_device;
   8
   9 =head1 NAME
  10
  11 FS::part_device - Object methods for part_device records
  12
  13 =head1 SYNOPSIS
  14
  15   use FS::part_device;
  16
  17   $record = new FS::part_device \%hash;
  18   $record = new FS::part_device { 'column' => 'value' };
  19
  20   $error = $record->insert;
  21
  22   $error = $new_record->replace($old_record);
  23
  24   $error = $record->delete;
  25
  26   $error = $record->check;
  27
  28 =head1 DESCRIPTION
  29
  30 An FS::part_device object represents a phone device definition. FS::part_device
  31 inherits from FS::Record.  The following fields are currently supported:
  32
  33 =over 4
  34
  35 =item devicepart
  36
  37 primary key
  38
  39 =item devicename
  40
  41 devicename
  42
  43 =item inventory_classnum
  44
  45 =back
  46
  47 =head1 METHODS
  48
  49 =over 4
  50
  51 =item new HASHREF
  52
  53 Creates a new record.  To add the record to the database, see L<"insert">.
  54
  55 Note that this stores the hash reference, not a distinct copy of the hash it
  56 points to.  You can ask the object for a copy with the I<hash> method.
  57
  58 =cut
  59
  60 # the new method can be inherited from FS::Record, if a table method is defined
  61
  62 sub table { 'part_device'; }
  63
  64 =item insert
  65
  66 Adds this record to the database.  If there is an error, returns the error,
  67 otherwise returns false.
  68
  69 =cut
  70
  71 # the insert method can be inherited from FS::Record
  72
  73 =item delete
  74
  75 Delete this record from the database.
  76
  77 =cut
  78
  79 # the delete method can be inherited from FS::Record
  80
  81 =item replace OLD_RECORD
  82
  83 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  84 returns the error, otherwise returns false.
  85
  86 =cut
  87
  88 # the replace method can be inherited from FS::Record
  89
  90 =item check
  91
  92 Checks all fields to make sure this is a valid record.  If there is
  93 an error, returns the error, otherwise returns false.  Called by the insert
  94 and replace methods.
  95
  96 =cut
  97
  98 # the check method should currently be supplied - FS::Record contains some
  99 # data checking routines
 100
 101 sub check {
 102   my $self = shift;
 103
 104   my $error =
 105     $self->ut_numbern('devicepart')
 106     || $self->ut_text('devicename')
 107     || $self->ut_foreign_keyn('inventory_classnum', 'inventory_class', 'classnum')
 108   ;
 109   return $error if $error;
 110
 111   $self->SUPER::check;
 112 }
 113
 114 =item part_export
 115
 116 Returns a list of all exports (see L<FS::part_export>) for this device.
 117
 118 =cut
 119
 120 sub part_export {
 121   my $self = shift;
 122   map { qsearchs( 'part_export', { 'exportnum' => $_->exportnum } ) }
 123     qsearch( 'export_device', { 'devicepart' => $self->devicepart } );
 124 }
 125
 126 =item inventory_class
 127
 128 Returns the inventory class (see L<FS::inventory_class>) for this device,
 129 if any.
 130
 131 =cut
 132
 133 sub inventory_class {
 134   my $self = shift;
 135   return '' unless $self->inventory_classnum;
 136   qsearchs('inventory_class', { 'classnum' => $self->inventory_classnum });
 137 }
 138
 139 sub process_batch_import {
 140   my $job = shift;
 141
 142   my $opt = { 'table'   => 'part_device',
 143               'params'  => [],
 144               'formats' => { 'default' => [ 'devicename' ] },
 145               'default_csv' => 1,
 146             };
 147
 148   FS::Record::process_batch_import( $job, $opt, @_ );
 149
 150 }
 151
 152 =back
 153
 154 =head1 BUGS
 155
 156 =head1 SEE ALSO
 157
 158 L<FS::Record>, schema.html from the base documentation.
 159
 160 =cut
 161
 162 1;
 163