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 codepkgnum - primary key
  39
  40 =item codenum - registration code (see L<FS::reg_code>)
  41
  42 =item pkgpart - package definition (see L<FS::part_pkg>)
  43
  44 =back
  45
  46 =head1 METHODS
  47
  48 =over 4
  49
  50 =item new HASHREF
  51
  52 Creates a new registration code.  To add the registration code to the database,
  53 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 # the new method can be inherited from FS::Record, if a table method is defined
  61
  62 sub table { 'reg_code_pkg'; }
  63
  64 =item insert
  65
  66 Adds this record to the database.  If there is an error, returns the error,
  67 otherwise returns false.
  68
  69 =cut
  70
  71 # the insert method can be inherited from FS::Record
  72
  73 =item delete
  74
  75 Delete this record from the database.
  76
  77 =cut
  78
  79 # the delete method can be inherited from FS::Record
  80
  81 =item replace OLD_RECORD
  82
  83 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  84 returns the error, otherwise returns false.
  85
  86 =cut
  87
  88 # the replace method can be inherited from FS::Record
  89
  90 =item check
  91
  92 Checks all fields to make sure this is a valid record.  If there is
  93 an error, returns the error, otherwise returns false.  Called by the insert
  94 and replace methods.
  95
  96 =cut
  97
  98 # the check method should currently be supplied - FS::Record contains some
  99 # data checking routines
 100
 101 sub check {
 102   my $self = shift;
 103
 104   my $error =
 105        $self->ut_numbern('codepkgnum')
 106     || $self->ut_foreign_key('codenum', 'reg_code', 'codenum')
 107     || $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart')
 108   ;
 109   return $error if $error;
 110
 111   $self->SUPER::check;
 112 }
 113
 114 =item part_pkg
 115
 116 Returns the package definition (see L<FS::part_pkg>)
 117
 118 =cut
 119
 120 sub part_pkg {
 121   my $self = shift;
 122   qsearchs('part_pkg', { 'pkgpart' => $self->pkgpart } );
 123 }
 124
 125 =back
 126
 127 =head1 BUGS
 128
 129 Feeping creaturitis.
 130
 131 =head1 SEE ALSO
 132
 133 L<FS::reg_code_pkg>, L<FS::Record>, schema.html from the base documentation.
 134
 135 =cut
 136
 137 1;
 138
 139