3 <TITLE>FS::prepay_credit - Object methods for prepay_credit records</TITLE>
4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
9 <A NAME="__index__"></A>
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>
26 <H1><A NAME="name">NAME</A></H1>
27 <P>FS::prepay_credit - Object methods for prepay_credit records</P>
30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
32 use FS::prepay_credit;</PRE>
34 $record = new FS::prepay_credit \%hash;
35 $record = new FS::prepay_credit {
36 'identifier' => '4198123455512121'
37 'amount' => '19.95',
40 $error = $record->insert;</PRE>
42 $error = $new_record->replace($old_record);</PRE>
44 $error = $record->delete;</PRE>
46 $error = $record->check;</PRE>
49 <H1><A NAME="description">DESCRIPTION</A></H1>
50 <P>An FS::table_name object represents an pre--paid credit, such as a pre-paid
51 ``calling card''. FS::prepay_credit inherits from FS::Record. The following
52 fields are currently supported:</P>
54 <DT><STRONG><A NAME="item_field_%2D_description">field - description</A></STRONG><BR>
56 <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>
58 <DT><STRONG><A NAME="item_amount_%2D_amount_of_the_credit">amount - amount of the credit</A></STRONG><BR>
63 <H1><A NAME="methods">METHODS</A></H1>
65 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
67 Creates a new pre-paid credit. To add the example to the database, see
68 <A HREF="#insert">insert</A>.
69 <P>Note that this stores the hash reference, not a distinct copy of the hash it
70 points to. You can ask the object for a copy with the <EM>hash</EM> method.</P>
72 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
74 Adds this record to the database. If there is an error, returns the error,
75 otherwise returns false.
77 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
79 Delete this record from the database.
81 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
83 Replaces the OLD_RECORD with this one in the database. If there is an error,
84 returns the error, otherwise returns false.
86 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
88 Checks all fields to make sure this is a valid pre-paid credit. If there is
89 an error, returns the error, otherwise returns false. Called by the insert
94 <H1><A NAME="version">VERSION</A></H1>
95 <P>$Id: prepay_credit.html,v 1.3 2002-01-29 17:42:46 ivan Exp $</P>
98 <H1><A NAME="bugs">BUGS</A></H1>
101 <H1><A NAME="see also">SEE ALSO</A></H1>
102 <P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, schema.html from the base documentation.</P>