3 <TITLE>FS::svc_Common - Object method for all svc_ records</TITLE>
4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
9 <A NAME="__index__"></A>
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>
26 <H1><A NAME="name">NAME</A></H1>
27 <P>FS::svc_Common - Object method for all svc_ records</P>
30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
31 <P>use FS::svc_Common;</P>
32 <P>@ISA = qw( FS::svc_Common );</P>
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>
40 <H1><A NAME="methods">METHODS</A></H1>
42 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
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>
49 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
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>
55 <DT><STRONG><A NAME="item_setfixed">setfixed</A></STRONG><BR>
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.
61 <DT><STRONG><A NAME="item_setdefault">setdefault</A></STRONG><BR>
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).
67 <DT><STRONG><A NAME="item_suspend">suspend</A></STRONG><BR>
69 <DT><STRONG><A NAME="item_unsuspend">unsuspend</A></STRONG><BR>
71 <DT><STRONG><A NAME="item_cancel">cancel</A></STRONG><BR>
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>).
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>
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>
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>