FS/FS/part_pkg_vendor.pm

   1 package FS::part_pkg_vendor;
   2 use base qw( FS::Record );
   3
   4 use strict;
   5
   6 =head1 NAME
   7
   8 FS::part_pkg_vendor - Object methods for part_pkg_vendor records
   9
  10 =head1 SYNOPSIS
  11
  12   use FS::part_pkg_vendor;
  13
  14   $record = new FS::part_pkg_vendor \%hash;
  15   $record = new FS::part_pkg_vendor { '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::part_pkg_vendor object represents a mapping of pkgpart numbers to
  28 external package numbers.  FS::part_pkg_vendor inherits from FS::Record.
  29 The following fields are currently supported:
  30
  31 =over 4
  32
  33 =item num
  34
  35 primary key
  36
  37 =item pkgpart
  38
  39 pkgpart
  40
  41 =item exportnum
  42
  43 exportnum
  44
  45 =item vendor_pkg_id
  46
  47 vendor_pkg_id
  48
  49
  50 =back
  51
  52 =head1 METHODS
  53
  54 =over 4
  55
  56 =item new HASHREF
  57
  58 Creates a new record.  To add the record 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 { 'part_pkg_vendor'; }
  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 record.  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('num')
 111     || $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart')
 112     || $self->ut_foreign_key('exportnum', 'part_export', 'exportnum')
 113     || $self->ut_textn('vendor_pkg_id')
 114   ;
 115   return $error if $error;
 116
 117   $self->SUPER::check;
 118 }
 119
 120 =item part_export
 121
 122 Returns the L<FS::part_export> associated with this vendor/external package id.
 123
 124 =back
 125
 126 =head1 SEE ALSO
 127
 128 L<FS::part_pkg>, L<FS::Record>, schema.html from the base documentation.
 129
 130 =cut
 131
 132 1;
 133