FS/FS/cust_svc_option.pm

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