3 <TITLE>FS::part_referral - Object methods for part_referral objects</TITLE>
4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
9 <A NAME="__index__"></A>
14 <LI><A HREF="#name">NAME</A></LI>
15 <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
16 <LI><A HREF="#description">DESCRIPTION</A></LI>
17 <LI><A HREF="#methods">METHODS</A></LI>
18 <LI><A HREF="#version">VERSION</A></LI>
19 <LI><A HREF="#bugs">BUGS</A></LI>
20 <LI><A HREF="#see also">SEE ALSO</A></LI>
26 <H1><A NAME="name">NAME</A></H1>
27 <P>FS::part_referral - Object methods for part_referral objects</P>
30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
32 use FS::part_referral;</PRE>
34 $record = new FS::part_referral \%hash
35 $record = new FS::part_referral { 'column' => 'value' };</PRE>
37 $error = $record->insert;</PRE>
39 $error = $new_record->replace($old_record);</PRE>
41 $error = $record->delete;</PRE>
43 $error = $record->check;</PRE>
46 <H1><A NAME="description">DESCRIPTION</A></H1>
47 <P>An FS::part_referral represents a referral - where a customer heard of your
48 services. This can be used to track the effectiveness of a particular piece of
49 advertising, for example. FS::part_referral inherits from FS::Record. The
50 following fields are currently supported:</P>
52 <DT><STRONG><A NAME="item_key">refnum - primary key (assigned automatically for new referrals)</A></STRONG><BR>
54 <DT><STRONG><A NAME="item_referral_%2D_Text_name_of_this_referral">referral - Text name of this referral</A></STRONG><BR>
59 <H1><A NAME="methods">METHODS</A></H1>
61 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
63 Creates a new referral. To add the referral to the database, see <A HREF="#insert">insert</A>.
65 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
67 Adds this referral to the database. If there is an error, returns the error,
68 otherwise returns false.
70 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
72 Currently unimplemented.
74 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
76 Replaces OLD_RECORD with this one in the database. If there is an error,
77 returns the error, otherwise returns false.
79 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
81 Checks all fields to make sure this is a valid referral. If there is an error,
82 returns the error, otherwise returns false. Called by the insert and replace
87 <H1><A NAME="version">VERSION</A></H1>
88 <P>$Id: part_referral.html,v 1.3 2002-01-29 17:42:46 ivan Exp $</P>
91 <H1><A NAME="bugs">BUGS</A></H1>
92 <P>The delete method is unimplemented.</P>
95 <H1><A NAME="see also">SEE ALSO</A></H1>
96 <P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>, schema.html from the base documentation.</P>