these are all auto-generated by the installation; don't check them into CVS
[freeside.git] / httemplate / docs / man / FS / prepay_credit.html
diff --git a/httemplate/docs/man/FS/prepay_credit.html b/httemplate/docs/man/FS/prepay_credit.html
deleted file mode 100644 (file)
index bb0c281..0000000
+++ /dev/null
@@ -1,106 +0,0 @@
-<HTML>
-<HEAD>
-<TITLE>FS::prepay_credit - Object methods for prepay_credit records</TITLE>
-<LINK REV="made" HREF="mailto:perl@packages.debian.org">
-</HEAD>
-
-<BODY>
-
-<A NAME="__index__"></A>
-<!-- INDEX BEGIN -->
-
-<UL>
-
-       <LI><A HREF="#name">NAME</A></LI>
-       <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
-       <LI><A HREF="#description">DESCRIPTION</A></LI>
-       <LI><A HREF="#methods">METHODS</A></LI>
-       <LI><A HREF="#version">VERSION</A></LI>
-       <LI><A HREF="#bugs">BUGS</A></LI>
-       <LI><A HREF="#see also">SEE ALSO</A></LI>
-</UL>
-<!-- INDEX END -->
-
-<HR>
-<P>
-<H1><A NAME="name">NAME</A></H1>
-<P>FS::prepay_credit - Object methods for prepay_credit records</P>
-<P>
-<HR>
-<H1><A NAME="synopsis">SYNOPSIS</A></H1>
-<PRE>
-  use FS::prepay_credit;</PRE>
-<PRE>
-  $record = new FS::prepay_credit \%hash;
-  $record = new FS::prepay_credit {
-    'identifier' =&gt; '4198123455512121'
-    'amount'     =&gt; '19.95',
-  };</PRE>
-<PRE>
-  $error = $record-&gt;insert;</PRE>
-<PRE>
-  $error = $new_record-&gt;replace($old_record);</PRE>
-<PRE>
-  $error = $record-&gt;delete;</PRE>
-<PRE>
-  $error = $record-&gt;check;</PRE>
-<P>
-<HR>
-<H1><A NAME="description">DESCRIPTION</A></H1>
-<P>An FS::table_name object represents an pre--paid credit, such as a pre-paid
-``calling card''.  FS::prepay_credit inherits from FS::Record.  The following
-fields are currently supported:</P>
-<DL>
-<DT><STRONG><A NAME="item_field_%2D_description">field - description</A></STRONG><BR>
-<DD>
-<DT><STRONG><A NAME="item_identifier_%2D_identifier_entered_by_the_user_to_r">identifier - identifier entered by the user to receive the credit</A></STRONG><BR>
-<DD>
-<DT><STRONG><A NAME="item_amount_%2D_amount_of_the_credit">amount - amount of the credit</A></STRONG><BR>
-<DD>
-</DL>
-<P>
-<HR>
-<H1><A NAME="methods">METHODS</A></H1>
-<DL>
-<DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
-<DD>
-Creates a new pre-paid credit.  To add the example to the database, see
-<A HREF="#insert">insert</A>.
-<P>Note that this stores the hash reference, not a distinct copy of the hash it
-points to.  You can ask the object for a copy with the <EM>hash</EM> method.</P>
-<P></P>
-<DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
-<DD>
-Adds this record to the database.  If there is an error, returns the error,
-otherwise returns false.
-<P></P>
-<DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
-<DD>
-Delete this record from the database.
-<P></P>
-<DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
-<DD>
-Replaces the OLD_RECORD with this one in the database.  If there is an error,
-returns the error, otherwise returns false.
-<P></P>
-<DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
-<DD>
-Checks all fields to make sure this is a valid pre-paid credit.  If there is
-an error, returns the error, otherwise returns false.  Called by the insert
-and replace methods.
-<P></P></DL>
-<P>
-<HR>
-<H1><A NAME="version">VERSION</A></H1>
-<P>$Id: prepay_credit.html,v 1.3 2002-01-29 17:42:46 ivan Exp $</P>
-<P>
-<HR>
-<H1><A NAME="bugs">BUGS</A></H1>
-<P>
-<HR>
-<H1><A NAME="see also">SEE ALSO</A></H1>
-<P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, schema.html from the base documentation.</P>
-
-</BODY>
-
-</HTML>