FS/FS/cust_pkg_option.pm

   1 package FS::cust_pkg_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_pkg_option - Object methods for cust_pkg_option records
  12
  13 =head1 SYNOPSIS
  14
  15   use FS::cust_pkg_option;
  16
  17   $record = new FS::cust_pkg_option \%hash;
  18   $record = new FS::cust_pkg_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_pkg_option object represents an option key an value for a
  31 customer package.  FS::cust_pkg_option inherits from
  32 FS::Record.  The following fields are currently supported:
  33
  34 =over 4
  35
  36 =item optionnum - primary key
  37
  38 =item pkgnum -
  39
  40 =item optionname -
  41
  42 =item optionvalue -
  43
  44
  45 =back
  46
  47 =head1 METHODS
  48
  49 =over 4
  50
  51 =item new HASHREF
  52
  53 Creates a new option.  To add the option 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 sub table { 'cust_pkg_option'; }
  61
  62 =item insert
  63
  64 Adds this record to the database.  If there is an error, returns the error,
  65 otherwise returns false.
  66
  67 =cut
  68
  69 =item delete
  70
  71 Delete this record from the database.
  72
  73 =cut
  74
  75 =item replace OLD_RECORD
  76
  77 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  78 returns the error, otherwise returns false.
  79
  80 =cut
  81
  82 =item check
  83
  84 Checks all fields to make sure this is a valid option.  If there is
  85 an error, returns the error, otherwise returns false.  Called by the insert
  86 and replace methods.
  87
  88 =cut
  89
  90 sub check {
  91   my $self = shift;
  92
  93   my $error =
  94     $self->ut_numbern('optionnum')
  95     || $self->ut_foreign_key('pkgnum', 'cust_pkg', 'pkgnum')
  96     || $self->ut_text('optionname')
  97     || $self->ut_textn('optionvalue')
  98   ;
  99   return $error if $error;
 100
 101   $self->SUPER::check;
 102 }
 103
 104 =back
 105
 106 =head1 BUGS
 107
 108 =head1 SEE ALSO
 109
 110 L<FS::Record>, L<FS::cust_pkg>, schema.html from the base documentation.
 111
 112 =cut
 113
 114 1;
 115