diff options
Diffstat (limited to 'httemplate/docs/man/FS/svc_Common.html')
-rw-r--r-- | httemplate/docs/man/FS/svc_Common.html | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/httemplate/docs/man/FS/svc_Common.html b/httemplate/docs/man/FS/svc_Common.html new file mode 100644 index 000000000..100aee880 --- /dev/null +++ b/httemplate/docs/man/FS/svc_Common.html @@ -0,0 +1,94 @@ +<HTML> +<HEAD> +<TITLE>FS::svc_Common - Object method for all svc_ records</TITLE> +<LINK REV="made" HREF="mailto:perl@packages.debian.org"> +</HEAD> + +<BODY> + +<A NAME="__index__"></A> +<!-- INDEX BEGIN --> + +<UL> + + <LI><A HREF="#name">NAME</A></LI> + <LI><A HREF="#synopsis">SYNOPSIS</A></LI> + <LI><A HREF="#description">DESCRIPTION</A></LI> + <LI><A HREF="#methods">METHODS</A></LI> + <LI><A HREF="#version">VERSION</A></LI> + <LI><A HREF="#bugs">BUGS</A></LI> + <LI><A HREF="#see also">SEE ALSO</A></LI> +</UL> +<!-- INDEX END --> + +<HR> +<P> +<H1><A NAME="name">NAME</A></H1> +<P>FS::svc_Common - Object method for all svc_ records</P> +<P> +<HR> +<H1><A NAME="synopsis">SYNOPSIS</A></H1> +<P>use FS::svc_Common;</P> +<P>@ISA = qw( FS::svc_Common );</P> +<P> +<HR> +<H1><A NAME="description">DESCRIPTION</A></H1> +<P>FS::svc_Common is intended as a base class for table-specific classes to +inherit from, i.e. FS::svc_acct. FS::svc_Common inherits from FS::Record.</P> +<P> +<HR> +<H1><A NAME="methods">METHODS</A></H1> +<DL> +<DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR> +<DD> +Adds this record to the database. If there is an error, returns the error, +otherwise returns false. +<P>The additional fields pkgnum and svcpart (see <A HREF=".././FS/cust_svc.html">the FS::cust_svc manpage</A>) should be +defined. An FS::cust_svc record will be created and inserted.</P> +<P></P> +<DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR> +<DD> +Deletes this account from the database. If there is an error, returns the +error, otherwise returns false. +<P>The corresponding FS::cust_svc record will be deleted as well.</P> +<P></P> +<DT><STRONG><A NAME="item_setfixed">setfixed</A></STRONG><BR> +<DD> +Sets any fixed fields for this service (see <A HREF=".././FS/part_svc.html">the FS::part_svc manpage</A>). If there is an +error, returns the error, otherwise returns the FS::part_svc object (use <CODE>ref()</CODE> +to test the return). Usually called by the check method. +<P></P> +<DT><STRONG><A NAME="item_setdefault">setdefault</A></STRONG><BR> +<DD> +Sets all fields to their defaults (see <A HREF=".././FS/part_svc.html">the FS::part_svc manpage</A>), overriding their +current values. If there is an error, returns the error, otherwise returns +the FS::part_svc object (use <CODE>ref()</CODE> to test the return). +<P></P> +<DT><STRONG><A NAME="item_suspend">suspend</A></STRONG><BR> +<DD> +<DT><STRONG><A NAME="item_unsuspend">unsuspend</A></STRONG><BR> +<DD> +<DT><STRONG><A NAME="item_cancel">cancel</A></STRONG><BR> +<DD> +Stubs - return false (no error) so derived classes don't need to define these +methods. Called by the cancel method of FS::cust_pkg (see <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>). +<P></P></DL> +<P> +<HR> +<H1><A NAME="version">VERSION</A></H1> +<P>$Id: svc_Common.html,v 1.1 2001-07-30 07:36:03 ivan Exp $</P> +<P> +<HR> +<H1><A NAME="bugs">BUGS</A></H1> +<P>The setfixed method return value.</P> +<P>The new method should set defaults from part_svc (like the check method +sets fixed values)?</P> +<P> +<HR> +<H1><A NAME="see also">SEE ALSO</A></H1> +<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 +from the base documentation.</P> + +</BODY> + +</HTML> |