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:perl@packages.debian.org">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <A NAME="__index__"></A>
  10 <!-- INDEX BEGIN -->
  11
  12 <UL>
  13
  14         <LI><A HREF="#name">NAME</A></LI>
  15         <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  16         <LI><A HREF="#description">DESCRIPTION</A></LI>
  17         <LI><A HREF="#methods">METHODS</A></LI>
  18         <LI><A HREF="#version">VERSION</A></LI>
  19         <LI><A HREF="#bugs">BUGS</A></LI>
  20         <LI><A HREF="#see also">SEE ALSO</A></LI>
  21 </UL>
  22 <!-- INDEX END -->
  23
  24 <HR>
  25 <P>
  26 <H1><A NAME="name">NAME</A></H1>
  27 <P>FS::pkg_svc - Object methods for pkg_svc records</P>
  28 <P>
  29 <HR>
  30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  31 <PRE>
  32   use FS::pkg_svc;</PRE>
  33 <PRE>
  34   $record = new FS::pkg_svc \%hash;
  35   $record = new FS::pkg_svc { 'column' =&gt; 'value' };</PRE>
  36 <PRE>
  37   $error = $record-&gt;insert;</PRE>
  38 <PRE>
  39   $error = $new_record-&gt;replace($old_record);</PRE>
  40 <PRE>
  41   $error = $record-&gt;delete;</PRE>
  42 <PRE>
  43   $error = $record-&gt;check;</PRE>
  44 <PRE>
  45   $part_pkg = $record-&gt;part_pkg;</PRE>
  46 <PRE>
  47   $part_svc = $record-&gt;part_svc;</PRE>
  48 <P>
  49 <HR>
  50 <H1><A NAME="description">DESCRIPTION</A></H1>
  51 <P>An FS::pkg_svc record links a billing item definition (see <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>) to
  52 a service definition (see <A HREF=".././FS/part_svc.html">the FS::part_svc manpage</A>).  FS::pkg_svc inherits from
  53 FS::Record.  The following fields are currently supported:</P>
  54 <DL>
  55 <DT><STRONG><A NAME="item_definition">pkgpart - Billing item definition (see <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>)</A></STRONG><BR>
  56 <DD>
  57 <DT><STRONG>svcpart - Service definition (see <A HREF=".././FS/part_svc.html">the FS::part_svc manpage</A>)</STRONG><BR>
  58 <DD>
  59 <DT><STRONG><A NAME="item_quantity_%2D_Quantity_of_this_service_definition_t">quantity - Quantity of this service definition that this billing item
  60 definition includes</A></STRONG><BR>
  61 <DD>
  62 </DL>
  63 <P>
  64 <HR>
  65 <H1><A NAME="methods">METHODS</A></H1>
  66 <DL>
  67 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
  68 <DD>
  69 Create a new record.  To add the record to the database, see <A HREF="#insert">insert</A>.
  70 <P></P>
  71 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
  72 <DD>
  73 Adds this record to the database.  If there is an error, returns the error,
  74 otherwise returns false.
  75 <P></P>
  76 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
  77 <DD>
  78 Deletes this record from the database.  If there is an error, returns the
  79 error, otherwise returns false.
  80 <P></P>
  81 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
  82 <DD>
  83 Replaces OLD_RECORD with this one in the database.  If there is an error,
  84 returns the error, otherwise returns false.
  85 <P></P>
  86 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
  87 <DD>
  88 Checks all fields to make sure this is a valid record.  If there is an error,
  89 returns the error, otherwise returns false.  Called by the insert and replace
  90 methods.
  91 <P></P>
  92 <DT><STRONG><A NAME="item_part_pkg">part_pkg</A></STRONG><BR>
  93 <DD>
  94 Returns the FS::part_pkg object (see <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>).
  95 <P></P>
  96 <DT><STRONG><A NAME="item_part_svc">part_svc</A></STRONG><BR>
  97 <DD>
  98 Returns the FS::part_svc object (see <A HREF=".././FS/part_svc.html">the FS::part_svc manpage</A>).
  99 <P></P></DL>
 100 <P>
 101 <HR>
 102 <H1><A NAME="version">VERSION</A></H1>
 103 <P>$Id: pkg_svc.html,v 1.3 2001-04-23 12:40:31 ivan Exp $</P>
 104 <P>
 105 <HR>
 106 <H1><A NAME="bugs">BUGS</A></H1>
 107 <P>
 108 <HR>
 109 <H1><A NAME="see also">SEE ALSO</A></H1>
 110 <P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>, <A HREF=".././FS/part_svc.html">the FS::part_svc manpage</A>, schema.html from the base
 111 documentation.</P>
 112
 113 </BODY>
 114
 115 </HTML>