From 2c816f314a8f3cc46e72e31f34ed97b4e11d0449 Mon Sep 17 00:00:00 2001 From: ivan Date: Wed, 4 Aug 1999 12:13:27 +0000 Subject: new HTML manpages --- htdocs/docs/man/FS/svc_domain.html | 196 +++++++++++++++++++++++++++++++++++++ 1 file changed, 196 insertions(+) create mode 100644 htdocs/docs/man/FS/svc_domain.html (limited to 'htdocs/docs/man/FS/svc_domain.html') diff --git a/htdocs/docs/man/FS/svc_domain.html b/htdocs/docs/man/FS/svc_domain.html new file mode 100644 index 000000000..9b5e1a53c --- /dev/null +++ b/htdocs/docs/man/FS/svc_domain.html @@ -0,0 +1,196 @@ + + +FS::svc_domain - Object methods for svc_domain records + + + + + + + +

+ + +

NAME

+FS::svc_domain - Object methods for svc_domain records + +

SYNOPSIS

  use FS::svc_domain;
+

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

  $error = $record->insert;
+

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

  $error = $record->delete;
+

  $error = $record->check;
+

  $error = $record->suspend;
+

  $error = $record->unsuspend;
+

  $error = $record->cancel;
+

DESCRIPTION

+An FS::svc_domain object represents a domain. FS::svc_domain inherits from +FS::svc_Common. The following fields are currently supported: + +

svcnum - primary key (assigned automatically for new accounts): +
domain: +

METHODS

new HASHREF

+Creates a new domain. To add the domain to the database, see insert. + +

insert

+Adds this domain 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. + +

+The additional field action should be set to N for new domains or M +for transfers. + +

+A registration or transfer email will be submitted unless +$FS::svc_domain::whois_hack is true. + +

+The additional field email can be used to manually set the admin contact email address on this email. +Otherwise, the svc_acct records for this package (see FS::cust_pkg) are searched. If there is exactly one svc_acct record in the same +package, it is automatically used. Otherwise an error is returned. + +

delete

+Deletes this domain 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. + +

replace OLD_RECORD

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

suspend

+Just returns false (no error) for now. + +

+Called by the suspend method of FS::cust_pkg (see FS::cust_pkg). + +

unsuspend

+Just returns false (no error) for now. + +

+Called by the unsuspend method of FS::cust_pkg (see FS::cust_pkg). + +

cancel

+Just returns false (no error) for now. + +

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

check

+Checks all fields to make sure this is a valid domain. If there is an +error, returns the error, otherwise returns false. Called by the insert and +replace methods. + +

+Sets any fixed values; see FS::part_svc. + +

whois