X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=htdocs%2Fdocs%2Fman%2FFS%2Fsvc_Common.html;fp=htdocs%2Fdocs%2Fman%2FFS%2Fsvc_Common.html;h=7ce9ff36a51b98131ec4873b851af3289d4db867;hp=970385b9f43a2430bdb07a28daaf25f18090de09;hb=f3235d39d083518d47f21cd5585e5f9a13070763;hpb=ece31063b782031e21ba1f57476afab555af5363 diff --git a/htdocs/docs/man/FS/svc_Common.html b/htdocs/docs/man/FS/svc_Common.html index 970385b9f..7ce9ff36a 100644 --- a/htdocs/docs/man/FS/svc_Common.html +++ b/htdocs/docs/man/FS/svc_Common.html @@ -1,108 +1,93 @@ FS::svc_Common - Object method for all svc_ records - + +

-

NAME

-

-FS::svc_Common - Object method for all svc_ records - +

NAME

+

FS::svc_Common - Object method for all svc_ records


-

SYNOPSIS

-

-use FS::svc_Common; - -

-@ISA = qw( FS::svc_Common ); - +

SYNOPSIS

+

use FS::svc_Common;

+

@ISA = qw( FS::svc_Common );


-

DESCRIPTION

-

-FS::svc_Common is intended as a base class for table-specific classes to -inherit from, i.e. FS::svc_acct. FS::svc_Common inherits from FS::Record. - +

DESCRIPTION

+

FS::svc_Common is intended as a base class for table-specific classes to +inherit from, i.e. FS::svc_acct. FS::svc_Common inherits from FS::Record.


-

METHODS

+

METHODS

-
insert
-

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

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

-The additional fields pkgnum and svcpart (see FS::cust_svc) should be defined. An FS::cust_svc record will be created and inserted. - -

delete
-

-Deletes this account from the database. If there is an error, returns the +

The additional fields pkgnum and svcpart (see the FS::cust_svc manpage) should be +defined. An FS::cust_svc record will be created and inserted.

+

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

-The corresponding FS::cust_svc record will be deleted as well. - -

setfixed
-

-Sets any fixed fields for this service (see FS::part_svc). If there is an error, returns the error, otherwise returns the -FS::part_svc object (use ref() to test the return). Usually -called by the check method. - -

setdefault
-

-Sets all fields to their defaults (see FS::part_svc), overriding their current values. If there is an error, returns the -error, otherwise returns the FS::part_svc object (use ref() to -test the return). - -

suspend
-
unsuspend
-
cancel
-

-Stubs - return false (no error) so derived classes don't need to define -these methods. Called by the cancel method of FS::cust_pkg (see FS::cust_pkg). - -

+

The corresponding FS::cust_svc record will be deleted as well.

+

+
setfixed
+
+Sets any fixed fields for this service (see the FS::part_svc manpage). If there is an +error, returns the error, otherwise returns the FS::part_svc object (use ref() +to test the return). Usually called by the check method. +

+
setdefault
+
+Sets all fields to their defaults (see the FS::part_svc manpage), overriding their +current values. If there is an error, returns the error, otherwise returns +the FS::part_svc object (use ref() to test the return). +

+
suspend
+
+
unsuspend
+
+
cancel
+
+Stubs - return false (no error) so derived classes don't need to define these +methods. Called by the cancel method of FS::cust_pkg (see the FS::cust_pkg manpage). +


-

VERSION

-

-$Id: svc_Common.html,v 1.2 2000-03-03 18:22:43 ivan Exp $ - +

VERSION

+

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


-

BUGS

-

-The setfixed method return value. - -

-The new method should set defaults from part_svc (like the check method -sets fixed values)? - +

BUGS

+

The setfixed method return value.

+

The new method should set defaults from part_svc (like the check method +sets fixed values)?


-

SEE ALSO

-

-FS::Record, FS::cust_svc, FS::part_svc, FS::cust_pkg, schema.html from the base documentation. +

SEE ALSO

+

the FS::Record manpage, the FS::cust_svc manpage, the FS::part_svc manpage, the FS::cust_pkg manpage, schema.html +from the base documentation.