diff options
| author | ivan <ivan> | 2002-01-29 17:46:41 +0000 |
|---|---|---|
| committer | ivan <ivan> | 2002-01-29 17:46:41 +0000 |
| commit | ea0d3938b57a079ce4aa6db0cae316e3ac6da654 (patch) | |
| tree | 1ee44728e7a81e1c7671ef154aee3c77fc565a7a /httemplate/docs/man/FS/part_pkg.html | |
| parent | c5c0ba135749164ec8ba75d18f76c29625e1bc7e (diff) | |
these are all auto-generated by the installation; don't check them into CVS
(probably should generate them for a release tarball though)
Diffstat (limited to 'httemplate/docs/man/FS/part_pkg.html')
| -rw-r--r-- | httemplate/docs/man/FS/part_pkg.html | 148 |
1 files changed, 0 insertions, 148 deletions
diff --git a/httemplate/docs/man/FS/part_pkg.html b/httemplate/docs/man/FS/part_pkg.html deleted file mode 100644 index e1e96b54c..000000000 --- a/httemplate/docs/man/FS/part_pkg.html +++ /dev/null @@ -1,148 +0,0 @@ -<HTML> -<HEAD> -<TITLE>FS::part_pkg - Object methods for part_pkg objects</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::part_pkg - Object methods for part_pkg objects</P> -<P> -<HR> -<H1><A NAME="synopsis">SYNOPSIS</A></H1> -<PRE> - use FS::part_pkg;</PRE> -<PRE> - $record = new FS::part_pkg \%hash - $record = new FS::part_pkg { 'column' => 'value' };</PRE> -<PRE> - $custom_record = $template_record->clone;</PRE> -<PRE> - $error = $record->insert;</PRE> -<PRE> - $error = $new_record->replace($old_record);</PRE> -<PRE> - $error = $record->delete;</PRE> -<PRE> - $error = $record->check;</PRE> -<PRE> - @pkg_svc = $record->pkg_svc;</PRE> -<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:</P> -<DL> -<DT><STRONG><A NAME="item_key">pkgpart - primary key (assigned automatically for new billing item definitions)</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_definition">pkg - Text name of this billing item definition (customer-viewable)</A></STRONG><BR> -<DD> -<DT><STRONG>comment - Text name of this billing item definition (non-customer-viewable)</STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_setup_%2D_Setup_fee_expression">setup - Setup fee expression</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_freq_%2D_Frequency_of_recurring_fee">freq - Frequency of recurring fee</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_recur_%2D_Recurring_fee_expression">recur - Recurring fee expression</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_setuptax_%2D_Setup_fee_tax_exempt_flag%2C_empty_or">setuptax - Setup fee tax exempt flag, empty or `Y'</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_recurtax_%2D_Recurring_fee_tax_exempt_flag%2C_empt">recurtax - Recurring fee tax exempt flag, empty or `Y'</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_plan_%2D_Price_plan">plan - Price plan</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_plandata_%2D_Price_plan_data">plandata - Price plan data</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_disabled_%2D_Disabled_flag%2C_empty_or_%60Y%27">disabled - Disabled flag, empty or `Y'</A></STRONG><BR> -<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> -<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 billing item definition. To add the billing item definition to -the database, see <A HREF="#insert">insert</A>. -<P></P> -<DT><STRONG><A NAME="item_clone">clone</A></STRONG><BR> -<DD> -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>. -<P></P> -<DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR> -<DD> -Adds this billing item definition 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> -Currently unimplemented. -<P></P> -<DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR> -<DD> -Replaces 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 billing item definition. If -there is an error, returns the error, otherwise returns false. Called by the -insert and replace methods. -<P></P> -<DT><STRONG><A NAME="item_pkg_svc">pkg_svc</A></STRONG><BR> -<DD> -Returns all FS::pkg_svc objects (see <A HREF=".././FS/pkg_svc.html">the FS::pkg_svc manpage</A>) for this package -definition (with non-zero quantity). -<P></P> -<DT><STRONG><A NAME="item_svcpart_%5B_SVCDB_%5D">svcpart [ SVCDB ]</A></STRONG><BR> -<DD> -Returns the svcpart of a single service definition (see <A HREF=".././FS/part_svc.html">the FS::part_svc manpage</A>) -associated with this billing item definition (see <A HREF=".././FS/pkg_svc.html">the FS::pkg_svc manpage</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, -<P></P></DL> -<P> -<HR> -<H1><A NAME="version">VERSION</A></H1> -<P>$Id: part_pkg.html,v 1.3 2002-01-29 17:42:46 ivan Exp $</P> -<P> -<HR> -<H1><A NAME="bugs">BUGS</A></H1> -<P>The delete method is unimplemented.</P> -<P>setup and recur semantics are not yet defined (and are implemented in -FS::cust_bill. hmm.).</P> -<P> -<HR> -<H1><A NAME="see also">SEE ALSO</A></H1> -<P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>, <A HREF=".././FS/type_pkgs.html">the FS::type_pkgs manpage</A>, <A HREF=".././FS/pkg_svc.html">the FS::pkg_svc manpage</A>, <EM>Safe</EM>. -schema.html from the base documentation.</P> - -</BODY> - -</HTML> |