FS/FS/cust_svc_option.pm

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