htdocs/docs/man/FS/cust_main_county.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::cust_main_county - Object methods for cust_main_county objects</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::cust_main_county - Object methods for cust_main_county objects</P>
  28 <P>
  29 <HR>
  30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  31 <PRE>
  32   use FS::cust_main_county;</PRE>
  33 <PRE>
  34   $record = new FS::cust_main_county \%hash;
  35   $record = new FS::cust_main_county { '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::cust_main_county object represents a tax rate, defined by locale.
  48 FS::cust_main_county inherits from FS::Record.  The following fields are
  49 currently supported:</P>
  50 <DL>
  51 <DT><STRONG><A NAME="item_key">taxnum - primary key (assigned automatically for new tax rates)</A></STRONG><BR>
  52 <DD>
  53 <DT><STRONG><A NAME="item_state">state</A></STRONG><BR>
  54 <DD>
  55 <DT><STRONG><A NAME="item_county">county</A></STRONG><BR>
  56 <DD>
  57 <DT><STRONG><A NAME="item_country">country</A></STRONG><BR>
  58 <DD>
  59 <DT><STRONG><A NAME="item_tax_%2D_percentage">tax - percentage</A></STRONG><BR>
  60 <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><BR>
  67 <DD>
  68 Creates a new tax rate.  To add the tax rate to the database, see <A HREF="#insert">insert</A>.
  69 <P></P>
  70 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
  71 <DD>
  72 Adds this tax rate to the database.  If there is an error, returns the error,
  73 otherwise returns false.
  74 <P></P>
  75 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
  76 <DD>
  77 Deletes this tax rate from the database.  If there is an error, returns the
  78 error, otherwise returns false.
  79 <P></P>
  80 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
  81 <DD>
  82 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  83 returns the error, otherwise returns false.
  84 <P></P>
  85 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
  86 <DD>
  87 Checks all fields to make sure this is a valid tax rate.  If there is an error,
  88 returns the error, otherwise returns false.  Called by the insert and replace
  89 methods.
  90 <P></P></DL>
  91 <P>
  92 <HR>
  93 <H1><A NAME="version">VERSION</A></H1>
  94 <P>$Id: cust_main_county.html,v 1.3 2001-04-23 12:40:31 ivan Exp $</P>
  95 <P>
  96 <HR>
  97 <H1><A NAME="bugs">BUGS</A></H1>
  98 <P>
  99 <HR>
 100 <H1><A NAME="see also">SEE ALSO</A></H1>
 101 <P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A>, <A HREF=".././FS/cust_bill.html">the FS::cust_bill manpage</A>, schema.html from the base
 102 documentation.</P>
 103
 104 </BODY>
 105
 106 </HTML>