--- /dev/null
+<HTML>
+<HEAD>
+<TITLE>FS::part_pkg - Object methods for part_pkg objects</TITLE>
+<LINK REV="made" HREF="mailto:ivan@rootwood.sisd.com">
+</HEAD>
+
+<BODY>
+
+<!-- INDEX BEGIN -->
+
+<UL>
+
+ <LI><A HREF="#NAME">NAME</A>
+ <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
+ <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
+ <LI><A HREF="#METHODS">METHODS</A>
+ <LI><A HREF="#VERSION">VERSION</A>
+ <LI><A HREF="#BUGS">BUGS</A>
+ <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
+</UL>
+<!-- INDEX END -->
+
+<HR>
+<P>
+<H1><A NAME="NAME">NAME</A></H1>
+<P>
+FS::part_pkg - Object methods for part_pkg objects
+
+<P>
+<HR>
+<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
+<P>
+<PRE> use FS::part_pkg;
+</PRE>
+<P>
+<PRE> $record = new FS::part_pkg \%hash
+ $record = new FS::part_pkg { 'column' => 'value' };
+</PRE>
+<P>
+<PRE> $custom_record = $template_record->clone;
+</PRE>
+<P>
+<PRE> $error = $record->insert;
+</PRE>
+<P>
+<PRE> $error = $new_record->replace($old_record);
+</PRE>
+<P>
+<PRE> $error = $record->delete;
+</PRE>
+<P>
+<PRE> $error = $record->check;
+</PRE>
+<P>
+<PRE> @pkg_svc = $record->pkg_svc;
+</PRE>
+<P>
+<PRE> $svcnum = $record->svcpart;
+ $svcnum = $record->svcpart( 'svc_acct' );
+</PRE>
+<P>
+<HR>
+<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
+<P>
+An FS::part_pkg object represents a billing item definition. FS::part_pkg
+inherits from FS::Record. The following fields are currently supported:
+
+<DL>
+<DT><STRONG><A NAME="item_pkgpart">pkgpart - primary key (assigned automatically for new billing item definitions)</A></STRONG><DD>
+<DT><STRONG><A NAME="item_pkg">pkg - Text name of this billing item definition (customer-viewable)</A></STRONG><DD>
+<DT><STRONG><A NAME="item_comment">comment - Text name of this billing item definition (non-customer-viewable)</A></STRONG><DD>
+<DT><STRONG><A NAME="item_setup">setup - Setup fee</A></STRONG><DD>
+<DT><STRONG><A NAME="item_freq">freq - Frequency of recurring fee</A></STRONG><DD>
+<DT><STRONG><A NAME="item_recur">recur - Recurring fee</A></STRONG><DD>
+</DL>
+<P>
+setup and recur are evaluated as Safe perl expressions. You can use numbers
+just as you would normally. More advanced semantics are not yet defined.
+
+<P>
+<HR>
+<H1><A NAME="METHODS">METHODS</A></H1>
+<DL>
+<DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><DD>
+<P>
+Creates a new billing item definition. To add the billing item definition
+to the database, see <A HREF="#insert">insert</A>.
+
+<DT><STRONG><A NAME="item_clone">clone</A></STRONG><DD>
+<P>
+An alternate constructor. Creates a new billing item definition by
+duplicating an existing definition. A new pkgpart is assigned and `(CUSTOM)
+' is prepended to the comment field. To add the billing item definition to
+the database, see
+<A HREF="#insert">insert</A>.
+
+<DT><STRONG><A NAME="item_insert">insert</A></STRONG><DD>
+<P>
+Adds this billing item definition to the database. If there is an error,
+returns the error, otherwise returns false.
+
+<DT><STRONG><A NAME="item_delete">delete</A></STRONG><DD>
+<P>
+Currently unimplemented.
+
+<DT><STRONG><A NAME="item_replace">replace OLD_RECORD</A></STRONG><DD>
+<P>
+Replaces OLD_RECORD with this one in the database. If there is an error,
+returns the error, otherwise returns false.
+
+<DT><STRONG><A NAME="item_check">check</A></STRONG><DD>
+<P>
+Checks all fields to make sure this is a valid billing item definition. If
+there is an error, returns the error, otherwise returns false. Called by
+the insert and replace methods.
+
+<DT><STRONG><A NAME="item_pkg_svc">pkg_svc</A></STRONG><DD>
+<P>
+Returns all FS::pkg_svc objects (see <A HREF="../FS/pkg_svc.html">FS::pkg_svc</A>) for this package definition.
+
+<DT><STRONG><A NAME="item_svcpart">svcpart [ SVCDB ]</A></STRONG><DD>
+<P>
+Returns the svcpart of a single service definition (see <A HREF="../FS/part_svc.html">FS::part_svc</A>) associated with this billing item definition (see <A HREF="../FS/pkg_svc.html">FS::pkg_svc</A>). Returns false if there not exactly one service definition with quantity
+1, or if SVCDB is specified and does not match the svcdb of the service
+definition,
+
+</DL>
+<P>
+<HR>
+<H1><A NAME="VERSION">VERSION</A></H1>
+<P>
+$Id: part_pkg.html,v 1.1 1999-08-04 12:13:27 ivan Exp $
+
+<P>
+<HR>
+<H1><A NAME="BUGS">BUGS</A></H1>
+<P>
+The delete method is unimplemented.
+
+<P>
+setup and recur semantics are not yet defined (and are implemented in
+FS::cust_bill. hmm.).
+
+<P>
+<HR>
+<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
+<P>
+<A HREF="../FS/Record.html">FS::Record</A>, <A HREF="../FS/cust_pkg.html">FS::cust_pkg</A>, <A HREF="../FS/type_pkgs.html">FS::type_pkgs</A>, <A HREF="../FS/pkg_svc.html">FS::pkg_svc</A>, <EM>Safe</EM>. schema.html from the base documentation.
+
+</BODY>
+
+</HTML>
projects / freeside.git / blobdiff