regenerated perl api docs from embedded pod

[freeside.git] / htdocs / docs / man / cust_svc.txt

diff --git a/htdocs/docs/man/cust_svc.txt b/htdocs/docs/man/cust_svc.txt
index d863ea8..206d9d3 100644 (file)
--- a/htdocs/docs/man/cust_svc.txt
+++ b/htdocs/docs/man/cust_svc.txt
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::cust_svc;
 
-      $record = create FS::cust_svc \%hash
-      $record = create FS::cust_svc { 'column' => 'value' };
+      $record = new FS::cust_svc \%hash
+      $record = new FS::cust_svc { 'column' => 'value' };
 
       $error = $record->insert;
 
@@ -15,6 +15,8 @@ SYNOPSIS
 
       $error = $record->check;
 
+      ($label, $value) = $record->label;
+
 DESCRIPTION
     An FS::cust_svc represents a service. FS::cust_svc inherits from
     FS::Record. The following fields are currently supported:
@@ -23,7 +25,7 @@ DESCRIPTION
     pkgnum - Package (see the FS::cust_pkg manpage)
     svcpart - Service definition (see the FS::part_svc manpage)
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new service. To add the refund to the database,
         see the section on "insert". Services are normally created
         by creating FS::svc_ objects (see the FS::svc_acct manpage,
@@ -51,12 +53,24 @@ METHODS
         there is an error, returns the error, otehrwise returns
         false. Called by the insert and replace methods.
 
+    label
+        Returns a list consisting of: - The name of this service
+        (from part_svc) - A meaningful identifier (username, domain,
+        or mail alias) - The table name (i.e. svc_domain) for this
+        service
+
+VERSION
+    $Id: cust_svc.txt,v 1.4 1999-04-08 13:39:32 ivan Exp $
+
 BUGS
     Behaviour of changing the svcpart of cust_svc records is
     undefined and should possibly be prohibited, and pkg_svc records
     are not checked.
 
-    pkg_svc records are not checket in general (here).
+    pkg_svc records are not checked in general (here).
+
+    Deleting this record doesn't check or delete the svc_* record
+    associated with this record.
 
 SEE ALSO
     the FS::Record manpage, the FS::cust_pkg manpage, the
@@ -70,3 +84,16 @@ HISTORY
 
     pod ivan@sisd.com 98-sep-21
 
+    $Log: cust_svc.txt,v $
+    Revision 1.4  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.5 1998/12/29 11:59:47 ivan
+    mostly properly OO, some work still to be done with svc_ stuff
+
+    Revision 1.4 1998/11/12 07:58:15 ivan added svcdb to label
+
+    Revision 1.3 1998/11/12 03:45:38 ivan use FS::table_name for all
+    tables qsearch()'ed
+
+    Revision 1.2 1998/11/12 03:32:46 ivan added label method
+