FS/FS/hardware_type.pm

   1 package FS::hardware_type;
   2
   3 use strict;
   4 use base qw( FS::Record );
   5 use FS::Record qw( qsearch qsearchs );
   6
   7 =head1 NAME
   8
   9 FS::hardware_type - Object methods for hardware_type records
  10
  11 =head1 SYNOPSIS
  12
  13   use FS::hardware_type;
  14
  15   $record = new FS::hardware_type \%hash;
  16   $record = new FS::hardware_type { 'column' => 'value' };
  17
  18   $error = $record->insert;
  19
  20   $error = $new_record->replace($old_record);
  21
  22   $error = $record->delete;
  23
  24   $error = $record->check;
  25
  26 =head1 DESCRIPTION
  27
  28 An FS::hardware_type object represents a device type (a model name or
  29 number) assignable as a hardware service (L<FS::svc_hardware)>).
  30 FS::hardware_type inherits from FS::Record.  The following fields are
  31 currently supported:
  32
  33 =over 4
  34
  35 =item typenum - primary key
  36
  37 =item classnum - key to an L<FS::hardware_class> record defining the class
  38 to which this device type belongs.
  39
  40 =item model - descriptive model name or number
  41
  42 =back
  43
  44 =head1 METHODS
  45
  46 =over 4
  47
  48 =item new HASHREF
  49
  50 Creates a new record.  To add the record to the database, see L<"insert">.
  51
  52 Note that this stores the hash reference, not a distinct copy of the hash it
  53 points to.  You can ask the object for a copy with the I<hash> method.
  54
  55 =cut
  56
  57 # the new method can be inherited from FS::Record, if a table method is defined
  58
  59 sub table { 'hardware_type'; }
  60
  61 =item insert
  62
  63 Adds this record to the database.  If there is an error, returns the error,
  64 otherwise returns false.
  65
  66 =cut
  67
  68 # the insert method can be inherited from FS::Record
  69
  70 =item delete
  71
  72 Delete this record from the database.
  73
  74 =cut
  75
  76 # the delete method can be inherited from FS::Record
  77
  78 =item replace OLD_RECORD
  79
  80 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  81 returns the error, otherwise returns false.
  82
  83 =cut
  84
  85 # the replace method can be inherited from FS::Record
  86
  87 =item check
  88
  89 Checks all fields to make sure this is a valid hardware type.  If there is
  90 an error, returns the error, otherwise returns false.  Called by the insert
  91 and replace methods.
  92
  93 =cut
  94
  95 # the check method should currently be supplied - FS::Record contains some
  96 # data checking routines
  97
  98 sub check {
  99   my $self = shift;
 100
 101   my $error =
 102     $self->ut_numbern('typenum')
 103     || $self->ut_foreign_key('classnum', 'hardware_class', 'classnum')
 104     || $self->ut_text('model')
 105   ;
 106   return $error if $error;
 107
 108   $self->SUPER::check;
 109 }
 110
 111 =item hardware_class
 112
 113 Returns the L<FS::hardware_class> associated with this device.
 114
 115 =cut
 116
 117 sub hardware_class {
 118   my $self = shift;
 119   return qsearchs('hardware_class', { 'classnum' => $self->classnum });
 120 }
 121
 122 =back
 123
 124 =head1 SEE ALSO
 125
 126 L<FS::svc_hardware>, L<FS::Record>, schema.html from the base documentation.
 127
 128 =cut
 129
 130 1;
 131