htdocs/docs/man/FS/part_referral.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::part_referral - Object methods for part_referral objects</TITLE>
   4 <LINK REV="made" HREF="mailto:none">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <!-- INDEX BEGIN -->
  10
  11 <UL>
  12
  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>
  20 </UL>
  21 <!-- INDEX END -->
  22
  23 <HR>
  24 <P>
  25 <H1><A NAME="NAME">NAME</A></H1>
  26 <P>
  27 FS::part_referral - Object methods for part_referral objects
  28
  29 <P>
  30 <HR>
  31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
  32 <P>
  33 <PRE>  use FS::part_referral;
  34 </PRE>
  35 <P>
  36 <PRE>  $record = new FS::part_referral \%hash
  37   $record = new FS::part_referral { 'column' =&gt; 'value' };
  38 </PRE>
  39 <P>
  40 <PRE>  $error = $record-&gt;insert;
  41 </PRE>
  42 <P>
  43 <PRE>  $error = $new_record-&gt;replace($old_record);
  44 </PRE>
  45 <P>
  46 <PRE>  $error = $record-&gt;delete;
  47 </PRE>
  48 <P>
  49 <PRE>  $error = $record-&gt;check;
  50 </PRE>
  51 <P>
  52 <HR>
  53 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
  54 <P>
  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:
  59
  60 <DL>
  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>
  63 </DL>
  64 <P>
  65 <HR>
  66 <H1><A NAME="METHODS">METHODS</A></H1>
  67 <DL>
  68 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
  69 <P>
  70 Creates a new referral. To add the referral to the database, see <A HREF="#insert">insert</A>.
  71
  72 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
  73 <P>
  74 Adds this referral to the database. If there is an error, returns the
  75 error, otherwise returns false.
  76
  77 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
  78 <P>
  79 Currently unimplemented.
  80
  81 <DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
  82 <P>
  83 Replaces OLD_RECORD with this one in the database. If there is an error,
  84 returns the error, otherwise returns false.
  85
  86 <DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
  87 <P>
  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
  90 replace methods.
  91
  92 </DL>
  93 <P>
  94 <HR>
  95 <H1><A NAME="VERSION">VERSION</A></H1>
  96 <P>
  97 $Id: part_referral.html,v 1.2 2000-03-03 18:22:43 ivan Exp $
  98
  99 <P>
 100 <HR>
 101 <H1><A NAME="BUGS">BUGS</A></H1>
 102 <P>
 103 The delete method is unimplemented.
 104
 105 <P>
 106 <HR>
 107 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
 108 <P>
 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.
 110
 111 </BODY>
 112
 113 </HTML>