2 FS::svc_domain - Object methods for svc_domain records
7 $record = create FS::svc_domain \%hash;
8 $record = create FS::svc_domain { 'column' => 'value' };
10 $error = $record->insert;
12 $error = $new_record->replace($old_record);
14 $error = $record->delete;
16 $error = $record->check;
18 $error = $record->suspend;
20 $error = $record->unsuspend;
22 $error = $record->cancel;
25 An FS::svc_domain object represents a domain. FS::svc_domain
26 inherits from FS::Record. The following fields are currently
29 svcnum - primary key (assigned automatically for new accounts)
33 Creates a new domain. To add the domain to the database, see
34 the section on "insert".
37 Adds this domain to the database. If there is an error,
38 returns the error, otherwise returns false.
40 The additional fields *pkgnum* and *svcpart* (see the
41 FS::cust_svc manpage) should be defined. An FS::cust_svc
42 record will be created and inserted.
44 The additional field *action* should be set to *N* for new
45 domains or *M* for transfers.
47 A registration or transfer email will be submitted unless
48 $FS::svc_domain::whois_hack is true.
50 The additional field *email* can be used to manually set the
51 admin contact email address on this email. Otherwise, the
52 svc_acct records for this package (see the FS::cust_pkg
53 manpage) are searched. If there is exactly one svc_acct
54 record in the same package, it is automatically used.
55 Otherwise an error is returned.
58 Deletes this domain from the database. If there is an error,
59 returns the error, otherwise returns false.
61 The corresponding FS::cust_svc record will be deleted as
65 Replaces OLD_RECORD with this one in the database. If there
66 is an error, returns the error, otherwise returns false.
69 Just returns false (no error) for now.
71 Called by the suspend method of FS::cust_pkg (see the
72 FS::cust_pkg manpage).
75 Just returns false (no error) for now.
77 Called by the unsuspend method of FS::cust_pkg (see the
78 FS::cust_pkg manpage).
81 Just returns false (no error) for now.
83 Called by the cancel method of FS::cust_pkg (see the
84 FS::cust_pkg manpage).
87 Checks all fields to make sure this is a valid domain. If
88 there is an error, returns the error, otherwise returns
89 false. Called by the insert and replace methods.
91 Sets any fixed values; see the FS::part_svc manpage.
98 and returns the output.
100 (Always returns *No match for domian "$domain".* if
101 $FS::svc_domain::whois_hack is set true.)
104 Submits a registration email for this domain.
107 It doesn't properly override FS::Record yet.
109 All BIND/DNS fields should be included (and exported).
111 All registries should be supported.
113 Not all configuration access is through FS::Conf!
115 Should change action to a real field.
118 the FS::Record manpage, the FS::Conf manpage, the FS::cust_svc
119 manpage, the FS::part_svc manpage, the FS::cust_pkg manpage, the
120 FS::SSH manpage, the ssh manpage, the dot-qmail manpage,
121 schema.html from the base documentation, config.html from the
125 $Id: svc_domain.txt,v 1.2 1998-11-13 09:56:45 ivan Exp $
128 ivan@voicenet.com 97-jul-21
130 rewrite ivan@sisd.com 98-mar-10
132 add internic bits ivan@sisd.com 98-mar-14
134 Changed 'day' to 'daytime' because Pg6.3 reserves the day word
135 bmccane@maxbaud.net 98-apr-3
137 /var/spool/freeside/conf/registries/internic/, Mail::Internet,
138 etc. ivan@sisd.com 98-jul-17-19
140 pod, some FS::Conf (not complete) ivan@sisd.com 98-sep-23
142 $Log: svc_domain.txt,v $
143 Revision 1.2 1998-11-13 09:56:45 ivan
144 change configuration file layout to support multiple distinct databases (with
145 own set of config files, export, etc.)
146 Revision 1.2 1998/10/14 08:18:21 ivan
147 More informative error messages and better doc for admin contact