htdocs/docs/man/FS/svc_Common.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::svc_Common - Object method for all svc_ records</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::svc_Common - Object method for all svc_ records
  28
  29 <P>
  30 <HR>
  31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
  32 <P>
  33 use FS::svc_Common;
  34
  35 <P>
  36 <CODE>@ISA</CODE> = <CODE>qw(</CODE> FS::svc_Common );
  37
  38 <P>
  39 <HR>
  40 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
  41 <P>
  42 FS::svc_Common is intended as a base class for table-specific classes to
  43 inherit from, i.e. FS::svc_acct. FS::svc_Common inherits from FS::Record.
  44
  45 <P>
  46 <HR>
  47 <H1><A NAME="METHODS">METHODS</A></H1>
  48 <DL>
  49 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
  50 <P>
  51 Adds this record to the database. If there is an error, returns the error,
  52 otherwise returns false.
  53
  54 <P>
  55 The additional fields pkgnum and svcpart (see <A HREF="../FS/cust_svc.html">FS::cust_svc</A>) should be defined. An FS::cust_svc record will be created and inserted.
  56
  57 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
  58 <P>
  59 Deletes this account from the database. If there is an error, returns the
  60 error, otherwise returns false.
  61
  62 <P>
  63 The corresponding FS::cust_svc record will be deleted as well.
  64
  65 <DT><STRONG><A NAME="item_setfixed">setfixed</A></STRONG><DD>
  66 <P>
  67 Sets any fixed fields for this service (see <A HREF="../FS/part_svc.html">FS::part_svc</A>). If there is an error, returns the error, otherwise returns the
  68 FS::part_svc object (use <CODE>ref()</CODE> to test the return). Usually
  69 called by the check method.
  70
  71 <DT><STRONG><A NAME="item_setdefault">setdefault</A></STRONG><DD>
  72 <P>
  73 Sets all fields to their defaults (see <A HREF="../FS/part_svc.html">FS::part_svc</A>), overriding their current values. If there is an error, returns the
  74 error, otherwise returns the FS::part_svc object (use <CODE>ref()</CODE> to
  75 test the return).
  76
  77 <DT><STRONG><A NAME="item_suspend">suspend</A></STRONG><DD>
  78 <DT><STRONG><A NAME="item_unsuspend">unsuspend</A></STRONG><DD>
  79 <DT><STRONG><A NAME="item_cancel">cancel</A></STRONG><DD>
  80 <P>
  81 Stubs - return false (no error) so derived classes don't need to define
  82 these methods. Called by the cancel method of FS::cust_pkg (see <A HREF="../FS/cust_pkg.html">FS::cust_pkg</A>).
  83
  84 </DL>
  85 <P>
  86 <HR>
  87 <H1><A NAME="VERSION">VERSION</A></H1>
  88 <P>
  89 $Id: svc_Common.html,v 1.2 2000-03-03 18:22:43 ivan Exp $
  90
  91 <P>
  92 <HR>
  93 <H1><A NAME="BUGS">BUGS</A></H1>
  94 <P>
  95 The setfixed method return value.
  96
  97 <P>
  98 The new method should set defaults from part_svc (like the check method
  99 sets fixed values)?
 100
 101 <P>
 102 <HR>
 103 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
 104 <P>
 105 <A HREF="../FS/Record.html">FS::Record</A>, <A HREF="../FS/cust_svc.html">FS::cust_svc</A>, <A HREF="../FS/part_svc.html">FS::part_svc</A>, <A HREF="../FS/cust_pkg.html">FS::cust_pkg</A>, schema.html from the base documentation.
 106
 107 </BODY>
 108
 109 </HTML>