htdocs/docs/man/FS/type_pkgs.html

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