htdocs/docs/man/part_svc.txt

   1 NAME
   2     FS::part_svc - Object methods for part_svc objects
   3
   4 SYNOPSIS
   5       use FS::part_svc;
   6
   7       $record = create FS::part_referral \%hash
   8       $record = create 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_svc represents a service definition. FS::part_svc
  20     inherits from FS::Record. The following fields are currently
  21     supported:
  22
  23     svcpart - primary key (assigned automatically for new service definitions)
  24     svc - text name of this service definition
  25     svcdb - table used for this service.  See the FS::svc_acct manpage,
  26     the FS::svc_domain manpage, and the FS::svc_acct_sm manpage, among others.
  27     *svcdb*__*field* - Default or fixed value for *field* in *svcdb*.
  28     *svcdb*__*field*_flag - defines *svcdb*__*field* action: null, `D' for default, or `F' for fixed
  29 METHODS
  30     create HASHREF
  31         Creates a new service definition. To add the service
  32         definition to the database, see the section on "insert".
  33
  34     insert
  35         Adds this service definition to the database. If there is an
  36         error, returns the error, otherwise returns false.
  37
  38     delete
  39         Currently unimplemented.
  40
  41     replace OLD_RECORD
  42         Replaces OLD_RECORD with this one in the database. If there
  43         is an error, returns the error, otherwise returns false.
  44
  45     check
  46         Checks all fields to make sure this is a valid service
  47         definition. If there is an error, returns the error,
  48         otherwise returns false. Called by the insert and replace
  49         methods.
  50
  51 BUGS
  52     It doesn't properly override FS::Record yet.
  53
  54     Delete is unimplemented.
  55
  56 SEE ALSO
  57     the FS::Record manpage, the FS::part_pkg manpage, the
  58     FS::pkg_svc manpage, the FS::cust_svc manpage, the FS::svc_acct
  59     manpage, the FS::svc_acct_sm manpage, the FS::svc_domain
  60     manpage, schema.html from the base documentation.
  61
  62 HISTORY
  63     ivan@sisd.com 97-nov-14
  64
  65     data checking/untainting calls into FS::Record added
  66     ivan@sisd.com 97-dec-6
  67
  68     pod ivan@sisd.com 98-sep-21
  69