3 <TITLE>FS::part_referral - Object methods for part_referral objects</TITLE>
4 <LINK REV="made" HREF="mailto:none">
13 <LI><A HREF="#NAME">NAME</A>
14 <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
15 <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
16 <LI><A HREF="#METHODS">METHODS</A>
17 <LI><A HREF="#VERSION">VERSION</A>
18 <LI><A HREF="#BUGS">BUGS</A>
19 <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
25 <H1><A NAME="NAME">NAME</A></H1>
27 FS::part_referral - Object methods for part_referral objects
31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
33 <PRE> use FS::part_referral;
36 <PRE> $record = new FS::part_referral \%hash
37 $record = new FS::part_referral { 'column' => 'value' };
40 <PRE> $error = $record->insert;
43 <PRE> $error = $new_record->replace($old_record);
46 <PRE> $error = $record->delete;
49 <PRE> $error = $record->check;
53 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
55 An FS::part_referral represents a referral - where a customer heard of your
56 services. This can be used to track the effectiveness of a particular piece
57 of advertising, for example. FS::part_referral inherits from FS::Record.
58 The following fields are currently supported:
61 <DT><STRONG><A NAME="item_refnum">refnum - primary key (assigned automatically for new referrals)</A></STRONG><DD>
62 <DT><STRONG><A NAME="item_referral">referral - Text name of this referral</A></STRONG><DD>
66 <H1><A NAME="METHODS">METHODS</A></H1>
68 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
70 Creates a new referral. To add the referral to the database, see <A HREF="#insert">insert</A>.
72 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
74 Adds this referral to the database. If there is an error, returns the
75 error, otherwise returns false.
77 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
79 Currently unimplemented.
81 <DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
83 Replaces OLD_RECORD with this one in the database. If there is an error,
84 returns the error, otherwise returns false.
86 <DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
88 Checks all fields to make sure this is a valid referral. If there is an
89 error, returns the error, otherwise returns false. Called by the insert and
95 <H1><A NAME="VERSION">VERSION</A></H1>
97 $Id: part_referral.html,v 1.2 2000-03-03 18:22:43 ivan Exp $
101 <H1><A NAME="BUGS">BUGS</A></H1>
103 The delete method is unimplemented.
107 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
109 <A HREF="../FS/Record.html">FS::Record</A>, <A HREF="../FS/cust_main.html">FS::cust_main</A>, schema.html from the base documentation.