FS/FS/reg_code_pkg.pm

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