htdocs/docs/man/part_referral.txt

   1 NAME
   2     FS::part_referral - Object methods for part_referral objects
   3
   4 SYNOPSIS
   5       use FS::part_referral;
   6
   7       $record = new FS::part_referral \%hash
   8       $record = new FS::part_referral { 'column' => 'value' };
   9
  10       $error = $record->insert;
  11
  12       $error = $new_record->replace($old_record);
  13
  14       $error = $record->delete;
  15
  16       $error = $record->check;
  17
  18 DESCRIPTION
  19     An FS::part_referral represents a referral - where a customer
  20     heard of your services. This can be used to track the
  21     effectiveness of a particular piece of advertising, for example.
  22     FS::part_referral inherits from FS::Record. The following fields
  23     are currently supported:
  24
  25     refnum - primary key (assigned automatically for new referrals)
  26     referral - Text name of this referral
  27 METHODS
  28     new HASHREF
  29         Creates a new referral. To add the referral to the database,
  30         see the section on "insert".
  31
  32     insert
  33         Adds this referral to the database. If there is an error,
  34         returns the error, otherwise returns false.
  35
  36     delete
  37         Currently unimplemented.
  38
  39     replace OLD_RECORD
  40         Replaces OLD_RECORD with this one in the database. If there
  41         is an error, returns the error, otherwise returns false.
  42
  43     check
  44         Checks all fields to make sure this is a valid referral. If
  45         there is an error, returns the error, otherwise returns
  46         false. Called by the insert and replace methods.
  47
  48 VERSION
  49     $Id: part_referral.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
  50
  51 BUGS
  52     The delete method is unimplemented.
  53
  54 SEE ALSO
  55     the FS::Record manpage, the FS::cust_main manpage, schema.html
  56     from the base documentation.
  57
  58 HISTORY
  59     Class dealing with referrals
  60
  61     ivan@sisd.com 98-feb-23
  62
  63     pod ivan@sisd.com 98-sep-21
  64
  65     $Log: part_referral.txt,v $
  66     Revision 1.3  1999-04-08 13:39:32  ivan
  67     convert from pod for 1.2.0 release
  68  Revision 1.2 1998/12/29 11:59:49 ivan
  69     mostly properly OO, some work still to be done with svc_ stuff
  70