FS/FS/dsl_device.pm

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