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
  44 =back
  45
  46 =head1 METHODS
  47
  48 =over 4
  49
  50 =item new HASHREF
  51
  52 Creates a new record.  To add the record to the database, see L<"insert">.
  53
  54 Note that this stores the hash reference, not a distinct copy of the hash it
  55 points to.  You can ask the object for a copy with the I<hash> method.
  56
  57 =cut
  58
  59 # the new method can be inherited from FS::Record, if a table method is defined
  60
  61 sub table { 'part_device'; }
  62
  63 =item insert
  64
  65 Adds this record to the database.  If there is an error, returns the error,
  66 otherwise returns false.
  67
  68 =cut
  69
  70 # the insert method can be inherited from FS::Record
  71
  72 =item delete
  73
  74 Delete this record from the database.
  75
  76 =cut
  77
  78 # the delete method can be inherited from FS::Record
  79
  80 =item replace OLD_RECORD
  81
  82 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  83 returns the error, otherwise returns false.
  84
  85 =cut
  86
  87 # the replace method can be inherited from FS::Record
  88
  89 =item check
  90
  91 Checks all fields to make sure this is a valid record.  If there is
  92 an error, returns the error, otherwise returns false.  Called by the insert
  93 and replace methods.
  94
  95 =cut
  96
  97 # the check method should currently be supplied - FS::Record contains some
  98 # data checking routines
  99
 100 sub check {
 101   my $self = shift;
 102
 103   my $error =
 104     $self->ut_numbern('devicepart')
 105     || $self->ut_text('devicename')
 106   ;
 107   return $error if $error;
 108
 109   $self->SUPER::check;
 110 }
 111
 112 =item part_export
 113
 114 Returns a list of all exports (see L<FS::part_export>) for this device.
 115
 116 =cut
 117
 118 sub part_export {
 119   my $self = shift;
 120   map { qsearchs( 'part_export', { 'exportnum' => $_->exportnum } ) }
 121     qsearch( 'export_device', { 'devicepart' => $self->devicepart } );
 122 }
 123
 124 sub process_batch_import {
 125   my $job = shift;
 126
 127   my $opt = { 'table'   => 'part_device',
 128               'params'  => [],
 129               'formats' => { 'default' => [ 'devicename' ] },
 130               'default_csv' => 1,
 131             };
 132
 133   FS::Record::process_batch_import( $job, $opt, @_ );
 134
 135 }
 136
 137 =back
 138
 139 =head1 BUGS
 140
 141 =head1 SEE ALSO
 142
 143 L<FS::Record>, schema.html from the base documentation.
 144
 145 =cut
 146
 147 1;
 148