convert from pod for 1.2.0 release

1 files changed, 75 insertions, 0 deletions

diff --git a/htdocs/docs/man/svc_Common.txt b/htdocs/docs/man/svc_Common.txt
new file mode 100644
index 000000000..d63b8f245
--- /dev/null
+++ b/htdocs/docs/man/svc_Common.txt
@@ -0,0 +1,75 @@
+NAME
+    FS::svc_Common - Object method for all svc_ records
+
+SYNOPSIS
+    use FS::svc_Common;
+
+    @ISA = qw( FS::svc_Common );
+
+DESCRIPTION
+    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.
+
+METHODS
+    insert
+        Adds this record to the database. If there is an error,
+        returns the error, otherwise returns false.
+
+        The additional fields pkgnum and svcpart (see the
+        FS::cust_svc manpage) should be defined. An FS::cust_svc
+        record will be created and inserted.
+
+    delete
+        Deletes this account from the database. If there is an
+        error, returns the error, otherwise returns false.
+
+        The corresponding FS::cust_svc record will be deleted as
+        well.
+
+    setfixed
+        Sets any fixed fields for this service (see the FS::part_svc
+        manpage). If there is an error, returns the error, otherwise
+        returns the FS::part_svc object (use ref() to test the
+        return). Usually called by the check method.
+
+    setdefault
+        Sets all fields to their defaults (see the FS::part_svc
+        manpage), overriding their current values. If there is an
+        error, returns the error, otherwise returns the FS::part_svc
+        object (use ref() to test the return).
+
+    suspend
+    unsuspend
+    cancel
+        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 the FS::cust_pkg manpage).
+
+VERSION
+    $Id: svc_Common.txt,v 1.1 1999-04-08 13:39:32 ivan Exp $
+
+BUGS
+    The setfixed method return value.
+
+    The new method should set defaults from part_svc (like the check
+    method sets fixed values)?
+
+SEE ALSO
+    the FS::Record manpage, the FS::cust_svc manpage, the
+    FS::part_svc manpage, the FS::cust_pkg manpage, schema.html from
+    the base documentation.
+
+HISTORY
+    $Log: svc_Common.txt,v $
+    Revision 1.1  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.3 1999/03/25 13:31:29 ivan
+    added setdefault method (generalized setfixed method to setx
+    method)
+
+    Revision 1.2 1999/01/25 12:26:14 ivan yet more mod_perl stuff
+
+    Revision 1.1 1998/12/30 00:30:45 ivan svc_ stuff is more
+    properly OO - has a common superclass FS::svc_Common
+