Merge branch 'master' of git.freeside.biz:/home/git/freeside
[freeside.git] / FS / FS / pkg_referral.pm
1 package FS::pkg_referral;
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::pkg_referral - Object methods for pkg_referral records
12
13 =head1 SYNOPSIS
14
15   use FS::pkg_referral;
16
17   $record = new FS::pkg_referral \%hash;
18   $record = new FS::pkg_referral { '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::pkg_referral object represents the association of an advertising source
31 with a specific customer package (purchase).  FS::pkg_referral inherits from
32 FS::Record.  The following fields are currently supported:
33
34 =over 4
35
36 =item pkgrefnum - primary key
37
38 =item pkgnum - Customer package.  See L<FS::cust_pkg>
39
40 =item refnum - Advertising source.  See L<FS::part_referral>
41
42 =back
43
44 =head1 METHODS
45
46 =over 4
47
48 =item new HASHREF
49
50 Creates a new record.  To add the record 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 { 'pkg_referral'; }
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_numbern('pkgrefnum')
103     || $self->ut_foreign_key('pkgnum', 'cust_pkg',      'pkgnum' )
104     || $self->ut_foreign_key('refnum', 'part_referral', 'refnum' )
105   ;
106   return $error if $error;
107
108   $self->SUPER::check;
109 }
110
111 =back
112
113 =head1 BUGS
114
115 Multiple pkg_referral records for a single package (configured off by default)
116 still seems weird.
117
118 =head1 SEE ALSO
119
120 L<FS::part_referral>, L<FS::cust_pkg>, L<FS::Record>, schema.html from the
121 base documentation.
122
123 =cut
124
125 1;
126