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/cust_svc.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/cust_svc.html')
| -rw-r--r-- | httemplate/docs/man/FS/cust_svc.html | 139 |
1 files changed, 0 insertions, 139 deletions
diff --git a/httemplate/docs/man/FS/cust_svc.html b/httemplate/docs/man/FS/cust_svc.html deleted file mode 100644 index 55c90e28e..000000000 --- a/httemplate/docs/man/FS/cust_svc.html +++ /dev/null @@ -1,139 +0,0 @@ -<HTML> -<HEAD> -<TITLE>FS::cust_svc - Object method for cust_svc 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::cust_svc - Object method for cust_svc objects</P> -<P> -<HR> -<H1><A NAME="synopsis">SYNOPSIS</A></H1> -<PRE> - use FS::cust_svc;</PRE> -<PRE> - $record = new FS::cust_svc \%hash - $record = new FS::cust_svc { 'column' => 'value' };</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> - ($label, $value) = $record->label;</PRE> -<P> -<HR> -<H1><A NAME="description">DESCRIPTION</A></H1> -<P>An FS::cust_svc represents a service. FS::cust_svc inherits from FS::Record. -The following fields are currently supported:</P> -<DL> -<DT><STRONG><A NAME="item_key">svcnum - primary key (assigned automatically for new services)</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_Package">pkgnum - Package (see <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>)</A></STRONG><BR> -<DD> -<DT><STRONG><A NAME="item_definition">svcpart - Service definition (see <A HREF=".././FS/part_svc.html">the FS::part_svc manpage</A>)</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 service. To add the refund to the database, see <A HREF="#insert">insert</A>. -Services are normally created by creating FS::svc_ objects (see -<A HREF=".././FS/svc_acct.html">the FS::svc_acct manpage</A>, <A HREF=".././FS/svc_domain.html">the FS::svc_domain manpage</A>, and <A HREF=".././FS/svc_forward.html">the FS::svc_forward manpage</A>, among others). -<P></P> -<DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR> -<DD> -Adds this service 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> -Deletes this service from the database. If there is an error, returns the -error, otherwise returns false. -<P>Called by the cancel method of the package (see <A HREF=".././FS/cust_pkg.html">the FS::cust_pkg manpage</A>).</P> -<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 service. If there is an error, -returns the error, otehrwise returns false. Called by the insert and -replace methods. -<P></P> -<DT><STRONG><A NAME="item_part_svc">part_svc</A></STRONG><BR> -<DD> -Returns the definition for this service, as a FS::part_svc object (see -<A HREF=".././FS/part_svc.html">the FS::part_svc manpage</A>). -<P></P> -<DT><STRONG><A NAME="item_cust_pkg">cust_pkg</A></STRONG><BR> -<DD> -Returns the definition for this service, as a FS::part_svc object (see -<A HREF=".././FS/part_svc.html">the FS::part_svc manpage</A>). -<P></P> -<DT><STRONG><A NAME="item_label">label</A></STRONG><BR> -<DD> -Returns a list consisting of: -- The name of this service (from part_svc) -- A meaningful identifier (username, domain, or mail alias) -- The table name (i.e. svc_domain) for this service -<P></P> -<DT><STRONG><A NAME="item_svc_x">svc_x</A></STRONG><BR> -<DD> -Returns the FS::svc_XXX object for this service (i.e. an FS::svc_acct object or -FS::svc_domain object, etc.) -<P></P> -<DT><STRONG><A NAME="item_seconds_since_TIMESTAMP">seconds_since TIMESTAMP</A></STRONG><BR> -<DD> -See <A HREF=".././FS/svc_acct.html#seconds_since">seconds_since in the FS::svc_acct manpage</A>. Equivalent to -$cust_svc->svc_x->seconds_since, but more efficient. Meaningless for records -where <STRONG>svcdb</STRONG> is not ``svc_acct''. -<P></P></DL> -<P> -<HR> -<H1><A NAME="version">VERSION</A></H1> -<P>$Id: cust_svc.html,v 1.3 2002-01-29 17:42:46 ivan Exp $</P> -<P> -<HR> -<H1><A NAME="bugs">BUGS</A></H1> -<P>Behaviour of changing the svcpart of cust_svc records is undefined and should -possibly be prohibited, and pkg_svc records are not checked.</P> -<P>pkg_svc records are not checked in general (here).</P> -<P>Deleting this record doesn't check or delete the svc_* record associated -with this record.</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/part_svc.html">the FS::part_svc manpage</A>, <A HREF=".././FS/pkg_svc.html">the FS::pkg_svc manpage</A>, -schema.html from the base documentation</P> - -</BODY> - -</HTML> |