htdocs/docs/man/svc_Common.txt

   1 NAME
   2     FS::svc_Common - Object method for all svc_ records
   3
   4 SYNOPSIS
   5     use FS::svc_Common;
   6
   7     @ISA = qw( FS::svc_Common );
   8
   9 DESCRIPTION
  10     FS::svc_Common is intended as a base class for table-specific
  11     classes to inherit from, i.e. FS::svc_acct. FS::svc_Common
  12     inherits from FS::Record.
  13
  14 METHODS
  15     insert
  16         Adds this record to the database. If there is an error,
  17         returns the error, otherwise returns false.
  18
  19         The additional fields pkgnum and svcpart (see the
  20         FS::cust_svc manpage) should be defined. An FS::cust_svc
  21         record will be created and inserted.
  22
  23     delete
  24         Deletes this account from the database. If there is an
  25         error, returns the error, otherwise returns false.
  26
  27         The corresponding FS::cust_svc record will be deleted as
  28         well.
  29
  30     setfixed
  31         Sets any fixed fields for this service (see the FS::part_svc
  32         manpage). If there is an error, returns the error, otherwise
  33         returns the FS::part_svc object (use ref() to test the
  34         return). Usually called by the check method.
  35
  36     setdefault
  37         Sets all fields to their defaults (see the FS::part_svc
  38         manpage), overriding their current values. If there is an
  39         error, returns the error, otherwise returns the FS::part_svc
  40         object (use ref() to test the return).
  41
  42     suspend
  43     unsuspend
  44     cancel
  45         Stubs - return false (no error) so derived classes don't
  46         need to define these methods. Called by the cancel method of
  47         FS::cust_pkg (see the FS::cust_pkg manpage).
  48
  49 VERSION
  50     $Id: svc_Common.txt,v 1.1 1999-04-08 13:39:32 ivan Exp $
  51
  52 BUGS
  53     The setfixed method return value.
  54
  55     The new method should set defaults from part_svc (like the check
  56     method sets fixed values)?
  57
  58 SEE ALSO
  59     the FS::Record manpage, the FS::cust_svc manpage, the
  60     FS::part_svc manpage, the FS::cust_pkg manpage, schema.html from
  61     the base documentation.
  62
  63 HISTORY
  64     $Log: svc_Common.txt,v $
  65     Revision 1.1  1999-04-08 13:39:32  ivan
  66     convert from pod for 1.2.0 release
  67  Revision 1.3 1999/03/25 13:31:29 ivan
  68     added setdefault method (generalized setfixed method to setx
  69     method)
  70
  71     Revision 1.2 1999/01/25 12:26:14 ivan yet more mod_perl stuff
  72
  73     Revision 1.1 1998/12/30 00:30:45 ivan svc_ stuff is more
  74     properly OO - has a common superclass FS::svc_Common
  75