FS/FS/hardware_type.pm

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