FS/FS/dsl_device.pm

   1 package FS::dsl_device;
   2 use base qw( FS::MAC_Mixin FS::Record );
   3
   4 use strict;
   5
   6 =head1 NAME
   7
   8 FS::dsl_device - Object methods for dsl_device records
   9
  10 =head1 SYNOPSIS
  11
  12   use FS::dsl_device;
  13
  14   $record = new FS::dsl_device \%hash;
  15   $record = new FS::dsl_device { '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::dsl_device object represents a specific customer MAC address.  The
  28 following fields are currently supported:
  29
  30 =over 4
  31
  32 =item devicenum
  33
  34 primary key
  35
  36 =item svcnum
  37
  38 svcnum
  39
  40 =item mac_addr
  41
  42 mac_addr
  43
  44
  45 =back
  46
  47 =head1 METHODS
  48
  49 =over 4
  50
  51 =item new HASHREF
  52
  53 Creates a new device.  To add the device 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 { 'dsl_device'; }
  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 device.  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('devicenum')
 106     || $self->ut_foreign_key('svcnum', 'svc_dsl', 'svcnum' )
 107     || $self->ut_mac_addr('mac_addr')
 108   ;
 109   return $error if $error;
 110
 111   $self->SUPER::check;
 112 }
 113
 114 =item svc_dsl
 115
 116 Returns the DSL (see L<FS::svc_dsl>) associated with this customer
 117 device.
 118
 119 =back
 120
 121 =head1 BUGS
 122
 123 =head1 SEE ALSO
 124
 125 L<FS::Record>, schema.html from the base documentation.
 126
 127 =cut
 128
 129 1;
 130