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