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=19416d5b7d481ee53d551cbdd28220c641aa7812;hp=5e73b17c97bb7109217260dfc05f1ff7c15dd246;hb=f3235d39d083518d47f21cd5585e5f9a13070763;hpb=ece31063b782031e21ba1f57476afab555af5363 diff --git a/htdocs/docs/man/FS/cust_svc.html b/htdocs/docs/man/FS/cust_svc.html index 5e73b17c9..19416d5b7 100644 --- a/htdocs/docs/man/FS/cust_svc.html +++ b/htdocs/docs/man/FS/cust_svc.html @@ -1,133 +1,117 @@ FS::cust_svc - Object method for cust_svc objects - + +

NAME -
SYNOPSIS -
DESCRIPTION -
METHODS -
VERSION -
BUGS -
SEE ALSO +
NAME
SYNOPSIS
DESCRIPTION
METHODS
VERSION
BUGS
SEE ALSO

NAME

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

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

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 FS::cust_pkg): -
svcpart - Service definition (see FS::part_svc): +
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 -FS::svc_acct, FS::svc_domain, and FS::svc_acct_sm, among others). - -

insert

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

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 +

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 FS::cust_pkg). - -

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 +

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

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.2 2000-03-03 18:22:43 ivan Exp $ - +

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

-Deleting this record doesn't check or delete the svc_* record associated -with this record. - +

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

Deleting this record doesn't check or delete the svc_* record associated +with this record.