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 =item title - external ID
  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 { 'hardware_type'; }
  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 hardware type.  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('typenum')
 106     || $self->ut_foreign_key('classnum', 'hardware_class', 'classnum')
 107     || $self->ut_text('model')
 108     || $self->ut_textn('revision')
 109     || $self->ut_textn('title')
 110   ;
 111   return $error if $error;
 112
 113   $self->SUPER::check;
 114 }
 115
 116 =item hardware_class
 117
 118 Returns the L<FS::hardware_class> associated with this device.
 119
 120 =item description
 121
 122 Returns the model and revision number.
 123
 124 =cut
 125
 126 sub description {
 127   my $self = shift;
 128   $self->model . ($self->revision ? ' '.$self->revision : '');
 129 }
 130
 131 =back
 132
 133 =head1 SEE ALSO
 134
 135 L<FS::svc_hardware>, L<FS::Record>, schema.html from the base documentation.
 136
 137 =cut
 138
 139 1;
 140