X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2Fcust_svc.html;fp=htdocs%2Fdocs%2Fman%2FFS%2Fcust_svc.html;h=0000000000000000000000000000000000000000;hp=19416d5b7d481ee53d551cbdd28220c641aa7812;hb=1d758388ce3b17b8de1ae1d3a8ec39c1026baefc;hpb=e6cf4af2b9d3ffefebe1a3e358f0674f566b56bc diff --git a/htdocs/docs/man/FS/cust_svc.html b/htdocs/docs/man/FS/cust_svc.html deleted file mode 100644 index 19416d5b7..000000000 --- a/htdocs/docs/man/FS/cust_svc.html +++ /dev/null @@ -1,118 +0,0 @@ - - -FS::cust_svc - Object method for cust_svc objects - - - - - - - - -

- - -

NAME

FS::cust_svc - Object method for cust_svc objects

SYNOPSIS

-  use FS::cust_svc;

-  $record = new FS::cust_svc \%hash
-  $record = new FS::cust_svc { 'column' => 'value' };

-  $error = $record->insert;

-  $error = $new_record->replace($old_record);

-  $error = $record->delete;

-  $error = $record->check;

-  ($label, $value) = $record->label;

DESCRIPTION

An FS::cust_svc represents a service. FS::cust_svc inherits from FS::Record. -The following fields are currently supported:

svcnum - primary key (assigned automatically for new services)
-: -
pkgnum - Package (see the FS::cust_pkg manpage)
-: -
svcpart - Service definition (see the FS::part_svc manpage)
-: -

METHODS

new HASHREF
-

-Creates a new service. To add the refund to the database, see insert. -Services are normally created by creating FS::svc_ objects (see -the FS::svc_acct manpage, the FS::svc_domain manpage, and the FS::svc_acct_sm manpage, among others). -

insert
-

-Adds this service to the database. If there is an error, returns the error, -otherwise returns false. -

delete
-

-Deletes this service from the database. If there is an error, returns the -error, otherwise returns false. -

Called by the cancel method of the package (see the FS::cust_pkg manpage).

replace OLD_RECORD
-

-Replaces the OLD_RECORD with this one in the database. If there is an error, -returns the error, otherwise returns false. -

check
-

-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. -

label
-

-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 -

VERSION

$Id: cust_svc.html,v 1.3 2001-04-23 12:40:31 ivan Exp $

BUGS

Behaviour of changing the svcpart of cust_svc records is undefined and should -possibly be prohibited, and pkg_svc records are not checked.

pkg_svc records are not checked in general (here).