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: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::type_pkgs - Object methods for type_pkgs records</P>
  28 <P>
  29 <HR>
  30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  31 <PRE>
  32   use FS::type_pkgs;</PRE>
  33 <PRE>
  34   $record = new FS::type_pkgs \%hash;
  35   $record = new FS::type_pkgs { '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 <P>
  45 <HR>
  46 <H1><A NAME="description">DESCRIPTION</A></H1>
  47 <P>An FS::type_pkgs record links an agent type (see <A HREF=".././FS/agent_type.html">the FS::agent_type manpage</A>) to a
  48 billing item definition (see <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A>).  FS::type_pkgs inherits from
  49 FS::Record.  The following fields are currently supported:</P>
  50 <DL>
  51 <DT><STRONG><A NAME="item_typenum_%2D_Agent_type%2C_see_FS%3A%3Aagent_type">typenum - Agent type, see <A HREF=".././FS/agent_type.html">the FS::agent_type manpage</A></A></STRONG><BR>
  52 <DD>
  53 <DT><STRONG><A NAME="item_pkgpart_%2D_Billing_item_definition%2C_see_FS%3A%3">pkgpart - Billing item definition, see <A HREF=".././FS/part_pkg.html">the FS::part_pkg manpage</A></A></STRONG><BR>
  54 <DD>
  55 </DL>
  56 <P>
  57 <HR>
  58 <H1><A NAME="methods">METHODS</A></H1>
  59 <DL>
  60 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
  61 <DD>
  62 Create a new record.  To add the record to the database, see <A HREF="#insert">insert</A>.
  63 <P></P>
  64 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
  65 <DD>
  66 Adds this record to the database.  If there is an error, returns the error,
  67 otherwise returns false.
  68 <P></P>
  69 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
  70 <DD>
  71 Deletes this record from the database.  If there is an error, returns the
  72 error, otherwise returns false.
  73 <P></P>
  74 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
  75 <DD>
  76 Replaces OLD_RECORD with this one in the database.  If there is an error,
  77 returns the error, otherwise returns false.
  78 <P></P>
  79 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
  80 <DD>
  81 Checks all fields to make sure this is a valid record.  If there is an error,
  82 returns the error, otherwise returns false.  Called by the insert and replace
  83 methods.
  84 <P></P></DL>
  85 <P>
  86 <HR>
  87 <H1><A NAME="version">VERSION</A></H1>
  88 <P>$Id: type_pkgs.html,v 1.3 2001-04-23 12:40:31 ivan Exp $</P>
  89 <P>
  90 <HR>
  91 <H1><A NAME="bugs">BUGS</A></H1>
  92 <P>
  93 <HR>
  94 <H1><A NAME="see also">SEE ALSO</A></H1>
  95 <P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/agent_type.html">the FS::agent_type manpage</A>, <A HREF="../FS/part_pkgs.html">the FS::part_pkgs manpage</A>, schema.html from the base
  96 documentation.</P>
  97
  98 </BODY>
  99
 100 </HTML>