htdocs/docs/man/FS/pkg_svc.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::pkg_svc - Object methods for pkg_svc records</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::pkg_svc - Object methods for pkg_svc records
  28
  29 <P>
  30 <HR>
  31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
  32 <P>
  33 <PRE>  use FS::pkg_svc;
  34 </PRE>
  35 <P>
  36 <PRE>  $record = new FS::pkg_svc \%hash;
  37   $record = new FS::pkg_svc { '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 <PRE>  $part_pkg = $record-&gt;part_pkg;
  53 </PRE>
  54 <P>
  55 <PRE>  $part_svc = $record-&gt;part_svc;
  56 </PRE>
  57 <P>
  58 <HR>
  59 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
  60 <P>
  61 An FS::pkg_svc record links a billing item definition (see <A HREF="../FS/part_pkg.html">FS::part_pkg</A>) to a service definition (see <A HREF="../FS/part_svc.html">FS::part_svc</A>). FS::pkg_svc inherits from FS::Record. The following fields are currently
  62 supported:
  63
  64 <DL>
  65 <DT><STRONG><A NAME="item_pkgpart">pkgpart - Billing item definition (see FS::part_pkg)</A></STRONG><DD>
  66 <DT><STRONG><A NAME="item_svcpart">svcpart - Service definition (see FS::part_svc)</A></STRONG><DD>
  67 <DT><STRONG><A NAME="item_quantity">quantity - Quantity of this service definition that this billing item
  68 definition includes</A></STRONG><DD>
  69 </DL>
  70 <P>
  71 <HR>
  72 <H1><A NAME="METHODS">METHODS</A></H1>
  73 <DL>
  74 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
  75 <P>
  76 Create a new record. To add the record to the database, see <A HREF="#insert">insert</A>.
  77
  78 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
  79 <P>
  80 Adds this record to the database. If there is an error, returns the error,
  81 otherwise returns false.
  82
  83 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
  84 <P>
  85 Deletes this record from the database. If there is an error, returns the
  86 error, otherwise returns false.
  87
  88 <DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
  89 <P>
  90 Replaces OLD_RECORD with this one in the database. If there is an error,
  91 returns the error, otherwise returns false.
  92
  93 <DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
  94 <P>
  95 Checks all fields to make sure this is a valid record. If there is an
  96 error, returns the error, otherwise returns false. Called by the insert and
  97 replace methods.
  98
  99 <DT><STRONG><A NAME="item_part_pkg">part_pkg</A></STRONG><DD>
 100 <P>
 101 Returns the FS::part_pkg object (see <A HREF="../FS/part_pkg.html">FS::part_pkg</A>).
 102
 103 <DT><STRONG><A NAME="item_part_svc">part_svc</A></STRONG><DD>
 104 <P>
 105 Returns the FS::part_svc object (see <A HREF="../FS/part_svc.html">FS::part_svc</A>).
 106
 107 </DL>
 108 <P>
 109 <HR>
 110 <H1><A NAME="VERSION">VERSION</A></H1>
 111 <P>
 112 $Id: pkg_svc.html,v 1.1 1999-08-04 12:13:27 ivan Exp $
 113
 114 <P>
 115 <HR>
 116 <H1><A NAME="BUGS">BUGS</A></H1>
 117 <P>
 118 <HR>
 119 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
 120 <P>
 121 <A HREF="../FS/Record.html">FS::Record</A>, <A HREF="../FS/part_pkg.html">FS::part_pkg</A>, <A HREF="../FS/part_svc.html">FS::part_svc</A>, schema.html from the base documentation.
 122
 123 </BODY>
 124
 125 </HTML>