X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Fman%2FFS%2Fcust_svc.html;fp=httemplate%2Fdocs%2Fman%2FFS%2Fcust_svc.html;h=0000000000000000000000000000000000000000;hb=ea0d3938b57a079ce4aa6db0cae316e3ac6da654;hp=55c90e28e232b465bec2fc4e3a479f23a5793b27;hpb=c5c0ba135749164ec8ba75d18f76c29625e1bc7e;p=freeside.git 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 @@ - - -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_forward 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. -

part_svc
-

-Returns the definition for this service, as a FS::part_svc object (see -the FS::part_svc manpage). -

cust_pkg
-

-Returns the definition for this service, as a FS::part_svc object (see -the FS::part_svc manpage). -

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 -

svc_x
-

-Returns the FS::svc_XXX object for this service (i.e. an FS::svc_acct object or -FS::svc_domain object, etc.) -

seconds_since TIMESTAMP
-

-See seconds_since in the FS::svc_acct manpage. Equivalent to -$cust_svc->svc_x->seconds_since, but more efficient. Meaningless for records -where svcdb is not ``svc_acct''. -

VERSION

$Id: cust_svc.html,v 1.3 2002-01-29 17:42:46 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).