httemplate/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:perl@packages.debian.org">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <A NAME="__index__"></A>
  10 <!-- INDEX BEGIN -->
  11
  12 <UL>
  13
  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>
  21 </UL>
  22 <!-- INDEX END -->
  23
  24 <HR>
  25 <P>
  26 <H1><A NAME="name">NAME</A></H1>
  27 <P>FS::part_referral - Object methods for part_referral objects</P>
  28 <P>
  29 <HR>
  30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  31 <PRE>
  32   use FS::part_referral;</PRE>
  33 <PRE>
  34   $record = new FS::part_referral \%hash
  35   $record = new FS::part_referral { 'column' =&gt; 'value' };</PRE>
  36 <PRE>
  37   $error = $record-&gt;insert;</PRE>
  38 <PRE>
  39   $error = $new_record-&gt;replace($old_record);</PRE>
  40 <PRE>
  41   $error = $record-&gt;delete;</PRE>
  42 <PRE>
  43   $error = $record-&gt;check;</PRE>
  44 <P>
  45 <HR>
  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>
  51 <DL>
  52 <DT><STRONG><A NAME="item_key">refnum - primary key (assigned automatically for new referrals)</A></STRONG><BR>
  53 <DD>
  54 <DT><STRONG><A NAME="item_referral_%2D_Text_name_of_this_referral">referral - Text name of this referral</A></STRONG><BR>
  55 <DD>
  56 </DL>
  57 <P>
  58 <HR>
  59 <H1><A NAME="methods">METHODS</A></H1>
  60 <DL>
  61 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
  62 <DD>
  63 Creates a new referral.  To add the referral to the database, see <A HREF="#insert">insert</A>.
  64 <P></P>
  65 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
  66 <DD>
  67 Adds this referral to the database.  If there is an error, returns the error,
  68 otherwise returns false.
  69 <P></P>
  70 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
  71 <DD>
  72 Currently unimplemented.
  73 <P></P>
  74 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
  75 <DD>
  76 Replaces OLD_RECORD with this one in the database.  If there is an error,
  77 returns the error, otherwise returns false.
  78 <P></P>
  79 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
  80 <DD>
  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
  83 methods.
  84 <P></P></DL>
  85 <P>
  86 <HR>
  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>
  89 <P>
  90 <HR>
  91 <H1><A NAME="bugs">BUGS</A></H1>
  92 <P>The delete method is unimplemented.</P>
  93 <P>
  94 <HR>
  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>
  97
  98 </BODY>
  99
 100 </HTML>