FS/FS/qual.pm

   1 package FS::qual;
   2
   3 use strict;
   4 use base qw( FS::Record );
   5 use FS::Record qw( qsearch qsearchs );
   6
   7 =head1 NAME
   8
   9 FS::qual - Object methods for qual records
  10
  11 =head1 SYNOPSIS
  12
  13   use FS::qual;
  14
  15   $record = new FS::qual \%hash;
  16   $record = new FS::qual { '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::qual object represents a qualification for service.  FS::qual inherits from
  29 FS::Record.  The following fields are currently supported:
  30
  31 =over 4
  32
  33 =item qualnum - primary key
  34
  35 =item contactnum - Contact (Prospect/Customer) - see L<FS::contact>
  36
  37 =item svctn - Service Telephone Number
  38
  39 =item svcdb - table used for this service.  See L<FS::svc_dsl> and
  40 L<FS::svc_broadband>, among others.
  41
  42 =item vendor_qual_id - qualification id from vendor/telco
  43
  44 =item status - qualification status (e.g. (N)ew, (P)ending, (Q)ualifies)
  45
  46
  47 =back
  48
  49 =head1 METHODS
  50
  51 =over 4
  52
  53 =item new HASHREF
  54
  55 Creates a new qualification.  To add the qualification 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 { 'qual'; }
  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 qualification.  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('qualnum')
 108     || $self->ut_number('contactnum')
 109     || $self->ut_numbern('svctn')
 110     || $self->ut_alpha('svcdb')
 111     || $self->ut_textn('vendor_qual_id')
 112     || $self->ut_alpha('status')
 113   ;
 114   return $error if $error;
 115
 116   $self->SUPER::check;
 117 }
 118
 119 =back
 120
 121 =head1 BUGS
 122
 123 This doesn't do anything yet.
 124
 125 =head1 SEE ALSO
 126
 127 L<FS::Record>, schema.html from the base documentation.
 128
 129 =cut
 130
 131 1;
 132