htdocs/docs/man/FS/part_svc.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::part_svc - Object methods for part_svc objects</TITLE>
   4 <LINK REV="made" HREF="mailto:ivan@rootwood.sisd.com">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <!-- INDEX BEGIN -->
  10
  11 <UL>
  12
  13         <LI><A HREF="#NAME">NAME</A>
  14         <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
  15         <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
  16         <LI><A HREF="#METHODS">METHODS</A>
  17         <LI><A HREF="#VERSION">VERSION</A>
  18         <LI><A HREF="#BUGS">BUGS</A>
  19         <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
  20 </UL>
  21 <!-- INDEX END -->
  22
  23 <HR>
  24 <P>
  25 <H1><A NAME="NAME">NAME</A></H1>
  26 <P>
  27 FS::part_svc - Object methods for part_svc objects
  28
  29 <P>
  30 <HR>
  31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
  32 <P>
  33 <PRE>  use FS::part_svc;
  34 </PRE>
  35 <P>
  36 <PRE>  $record = new FS::part_referral \%hash
  37   $record = new FS::part_referral { 'column' =&gt; 'value' };
  38 </PRE>
  39 <P>
  40 <PRE>  $error = $record-&gt;insert;
  41 </PRE>
  42 <P>
  43 <PRE>  $error = $new_record-&gt;replace($old_record);
  44 </PRE>
  45 <P>
  46 <PRE>  $error = $record-&gt;delete;
  47 </PRE>
  48 <P>
  49 <PRE>  $error = $record-&gt;check;
  50 </PRE>
  51 <P>
  52 <HR>
  53 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
  54 <P>
  55 An FS::part_svc represents a service definition. FS::part_svc inherits from
  56 FS::Record. The following fields are currently supported:
  57
  58 <DL>
  59 <DT><STRONG><A NAME="item_svcpart">svcpart - primary key (assigned automatically for new service definitions)</A></STRONG><DD>
  60 <DT><STRONG><A NAME="item_svc">svc - text name of this service definition</A></STRONG><DD>
  61 <DT><STRONG><A NAME="item_svcdb">svcdb - table used for this service.  See FS::svc_acct,
  62 FS::svc_domain, and FS::svc_acct_sm, among others.</A></STRONG><DD>
  63 <DT><STRONG><A NAME="item_svcdb_field">svcdb__field - Default or fixed value for field in svcdb.</A></STRONG><DD>
  64 <DT><STRONG><A NAME="item_svcdb_field_flag">svcdb__field_flag - defines svcdb__field action: null, `D' for default, or `F' for fixed</A></STRONG><DD>
  65 </DL>
  66 <P>
  67 <HR>
  68 <H1><A NAME="METHODS">METHODS</A></H1>
  69 <DL>
  70 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
  71 <P>
  72 Creates a new service definition. To add the service definition to the
  73 database, see <A HREF="#insert">insert</A>.
  74
  75 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
  76 <P>
  77 Adds this service definition to the database. If there is an error, returns
  78 the error, otherwise returns false.
  79
  80 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
  81 <P>
  82 Currently unimplemented.
  83
  84 <DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
  85 <P>
  86 Replaces OLD_RECORD with this one in the database. If there is an error,
  87 returns the error, otherwise returns false.
  88
  89 <DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
  90 <P>
  91 Checks all fields to make sure this is a valid service definition. If there
  92 is an error, returns the error, otherwise returns false. Called by the
  93 insert and replace methods.
  94
  95 </DL>
  96 <P>
  97 <HR>
  98 <H1><A NAME="VERSION">VERSION</A></H1>
  99 <P>
 100 $Id: part_svc.html,v 1.1 1999-08-04 12:13:27 ivan Exp $
 101
 102 <P>
 103 <HR>
 104 <H1><A NAME="BUGS">BUGS</A></H1>
 105 <P>
 106 Delete is unimplemented.
 107
 108 <P>
 109 The list of svc_* tables is hardcoded. When svc_acct_pop is renamed, this
 110 should be fixed.
 111
 112 <P>
 113 <HR>
 114 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
 115 <P>
 116 <A HREF="../FS/Record.html">FS::Record</A>, <A HREF="../FS/part_pkg.html">FS::part_pkg</A>, <A HREF="../FS/pkg_svc.html">FS::pkg_svc</A>, <A HREF="../FS/cust_svc.html">FS::cust_svc</A>,
 117 <A HREF="../FS/svc_acct.html">FS::svc_acct</A>, <A HREF="../FS/svc_acct_sm.html">FS::svc_acct_sm</A>, <A HREF="../FS/svc_domain.html">FS::svc_domain</A>, schema.html from the base documentation.
 118
 119 </BODY>
 120
 121 </HTML>