4 use vars qw( @ISA $conf $DEBUG $me );
5 use FS::Record qw( qsearch qsearchs );
11 @ISA = qw( FS::svc_Common );
13 $me = '[FS::svc_dsl]';
15 FS::UID->install_callback( sub {
22 FS::svc_dsl - Object methods for svc_dsl records
28 $record = new FS::svc_dsl \%hash;
29 $record = new FS::svc_dsl { 'column' => 'value' };
31 $error = $record->insert;
33 $error = $new_record->replace($old_record);
35 $error = $record->delete;
37 $error = $record->check;
39 $error = $record->suspend;
41 $error = $record->unsuspend;
43 $error = $record->cancel;
47 An FS::svc_dsl object represents a DSL service. FS::svc_dsl inherits from
48 FS::svc_Common. The following fields are currently supported:
52 =item svcnum - Primary key (assigned automatcially for new DSL))
54 =item pushed - Time DSL order pushed to vendor/telco, if applicable
56 =item desired_due_date - Desired Due Date
58 =item due_date - Due Date
60 =item vendor_order_id - Vendor/telco DSL order #
62 =item vendor_order_type
64 Vendor/telco DSL order type (e.g. (M)ove, (A)dd, (C)hange, (D)elete, or similar)
66 =item vendor_order_status
68 Vendor/telco DSL order status (e.g. (N)ew, (A)ssigned, (R)ejected, (M)revised,
69 (C)ompleted, (X)cancelled, or similar)
71 =item first - End-user first name
73 =item last - End-user last name
75 =item company - End-user company name
77 =item phonenum - DSL Telephone Number
79 =item loop_type - Loop-type - vendor/telco-specific
81 =item local_voice_provider - Local Voice Provider's name
83 =item circuitnum - Circuit #
89 =item rate_band - Rate Band
99 Ikano-specific fields, do not use otherwise
101 =item username - if outsourced PPPoE/RADIUS, username
103 =item password - if outsourced PPPoE/RADIUS, password
105 =item monitored - Order is monitored (auto-pull/sync), either Y or blank
107 =item last_pull - time of last data pull from vendor/telco
118 Creates a new DSL. To add the DSL to the database, see L<"insert">.
120 Note that this stores the hash reference, not a distinct copy of the hash it
121 points to. You can ask the object for a copy with the I<hash> method.
125 # the new method can be inherited from FS::Record, if a table method is defined
128 my %dis1 = ( disable_default=>1, disable_fixed=>1, disable_inventory=>1, disable_select=>1 );
129 my %dis2 = ( disable_inventory=>1, disable_select=>1 );
133 'name_plural' => 'DSLs',
134 'lcname_plural' => 'DSLs',
135 'sorts' => [ 'phonenum' ],
136 'display_weight' => 55,
137 'cancel_weight' => 75,
139 'pushed' => { label => 'Pushed',
140 type => 'disabled' },
141 'desired_due_date' => { label => 'Desired Due Date', %dis2, },
142 'due_date' => { label => 'Due Date', %dis2, },
143 'vendor_order_id' => { label => 'Vendor Order ID', %dis2, },
144 'vendor_qual_id' => { label => 'Vendor Qualification ID',
145 type => 'disabled' },
146 'vendor_order_type' => { label => 'Vendor Order Type',
147 disable_inventory => 1,
149 'vendor_order_status' => { label => 'Vendor Order Status',
150 disable_inventory => 1,
152 'first' => { label => 'First Name', %dis2, },
153 'last' => { label => 'Last Name', %dis2, },
154 'company' => { label => 'Company Name', %dis2, },
155 'phonenum' => { label => 'Service Telephone Number', },
156 'loop_type' => { label => 'Loop Type',
157 disable_inventory => 1,
159 'local_voice_provider' => { label => 'Local Voice Provider',
160 disable_inventory => 1,
162 'circuitnum' => { label => 'Circuit #', },
163 'rate_band' => { label => 'Rate Band',
164 disable_inventory => 1,
166 'vpi' => { label => 'VPI', disable_inventory => 1 },
167 'vci' => { label => 'VCI', disable_inventory => 1 },
168 'isp_chg' => { label => 'ISP Changing?',
169 type => 'checkbox', %dis2 },
170 'isp_prev' => { label => 'Current or Previous ISP',
171 disable_inventory => 1,
173 'username' => { label => 'PPPoE Username',
176 'password' => { label => 'PPPoE Password', %dis2 },
177 'staticips' => { label => 'Static IPs', %dis1 },
178 'monitored' => { label => 'Monitored',
179 type => 'checkbox', %dis2 },
180 'last_pull' => { label => 'Last Pull', type => 'disabled' },
185 sub table { 'svc_dsl'; }
189 return $self->phonenum if $self->phonenum;
190 return $self->username if $self->username;
191 return $self->vendor_order_id if $self->vendor_order_id;
192 return $self->svcnum;
197 Returns the set of FS::dsl_notes associated with this service
202 qsearch( 'dsl_note', { 'svcnum' => $self->svcnum } );
207 Adds this record to the database. If there is an error, returns the error,
208 otherwise returns false.
212 # the insert method can be inherited from FS::Record
216 Delete this record from the database.
220 # the delete method can be inherited from FS::Record
222 =item replace OLD_RECORD
224 Replaces the OLD_RECORD with this one in the database. If there is an error,
225 returns the error, otherwise returns false.
229 # the replace method can be inherited from FS::Record
233 Checks all fields to make sure this is a valid DSL. If there is
234 an error, returns the error, otherwise returns false. Called by the insert
239 # the check method should currently be supplied - FS::Record contains some
240 # data checking routines
246 $self->ut_numbern('svcnum')
247 || $self->ut_numbern('pushed')
248 || $self->ut_numbern('desired_due_date')
249 || $self->ut_numbern('due_date')
250 || $self->ut_textn('vendor_order_id')
251 || $self->ut_textn('vendor_qual_id')
252 || $self->ut_alphan('vendor_order_type')
253 || $self->ut_alphan('vendor_order_status')
254 || $self->ut_textn('first')
255 || $self->ut_textn('last')
256 || $self->ut_textn('company')
257 || $self->ut_numbern('phonenum')
258 || $self->ut_alphasn('loop_type')
259 || $self->ut_textn('local_voice_provider')
260 || $self->ut_textn('circuitnum')
261 || $self->ut_textn('rate_band')
262 || $self->ut_numbern('vpi')
263 || $self->ut_numbern('vci')
264 || $self->ut_alphan('isp_chg')
265 || $self->ut_textn('isp_prev')
266 || $self->ut_textn('username')
267 || $self->ut_textn('password')
268 || $self->ut_textn('staticips')
269 || $self->ut_enum('monitored', [ '', 'Y' ])
270 || $self->ut_numbern('last_pull')
272 return $error if $error;
279 Returns the MAC addresses associated with this DSL service, as FS::dsl_device
286 qsearch('dsl_device', { 'svcnum' => $self->svcnum });
289 sub predelete_hook_first {
291 my @exports = $self->part_svc->part_export_dsl_pull;
292 return 'More than one DSL-pulling export attached' if scalar(@exports) > 1;
293 if ( scalar(@exports) == 1 ) {
294 my $export = $exports[0];
295 return $export->dsl_pull($self);
302 my @notes = $self->notes;
303 foreach my $note ( @notes ) {
304 my $error = $note->delete;
305 return $error if $error;
314 L<FS::svc_Common>, edit/part_svc.cgi from an installed web interface,
315 export.html from the base documentation, L<FS::Record>, L<FS::Conf>,
316 L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, L<FS::queue>,
317 L<freeside-queued>, schema.html from the base documentation.