summaryrefslogtreecommitdiff
path: root/FS/FS/svc_alarm.pm
blob: 1714109e5dde471236a939a890d112d86a035229 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
package FS::svc_alarm;
use base qw( FS::svc_Common );

use strict;
use Tie::IxHash;
use FS::alarm_system;
use FS::alarm_type;
use FS::alarm_station;

=head1 NAME

FS::svc_alarm - Object methods for svc_alarm records

=head1 SYNOPSIS

  use FS::svc_alarm;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::svc_alarm object represents an alarm service.  FS::svc_alarm inherits
from FS::svc_Common.

The following fields are currently supported:

=over 4

=item svcnum - Primary key

=item alarmsystemnum - Alarm System Vendor (see L<FS::alarm_system>)

=item alarmtypenum - Alarm System Type (inputs/outputs) (see L<FS::alarm_type>)

=item alarmstationnum - Alarm central station (see L<FS::alarm_station>)

=item acctnum - Account number

=item _password - Password

=item location - Location on property

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new svc_dish object.

=cut

sub table { 'svc_alarm'; }

sub table_info {
  my %opts = ( 'type' => 'text', 
               #'disable_select' => 1,
               'disable_inventory' => 1,
             );

  tie my %fields, 'Tie::IxHash',
    'svcnum'    => { label => 'Service' },
    'acctnum'         => { label => 'Account #', %opts },
    '_password'       => { label => 'Password' , %opts },
    'location'        => { label => 'Location',  %opts },
    'cs_receiver'     => { label => 'CS Receiver #'},
    'cs_phonenum'     => { label => 'CS Phone #' },
    'serialnum'       => { label => 'Alarm Serial #' },
    'alarmsystemnum'  => { label => 'Alarm System Vendor',
                           type  => 'select-alarm_system',
                           disable_inventory => 1,
                           value_callback    => sub {
                             shift->alarm_system->systemname
                           },
                         },
    'alarmtypenum'    => { label => 'Alarm System Type',
                           type  => 'select-alarm_type',
                           disable_inventory => 1,
                           value_callback    => sub {
                             shift->alarm_type->typename
                           },
                         },
    'alarmstationnum' => { label => 'Alarm Central Station',
                           type  => 'select-alarm_station',
                           disable_inventory => 1,
                           value_callback    => sub {
                             shift->alarm_station->stationname
                           },
                         },
  ;

  {
    'name'                => 'Alarm service',
    'sorts'               => 'acctnum',
    'display_weight'      => 80,
    'cancel_weight'       => 85,
    'fields'              => \%fields,
    'addl_process_fields' => [qw( alarmsystemnum_systemname
                                  alarmtypenum_inputs alarmtypenum_outputs
                                  alarmstationnum_stationname
                             )],
  };
}

sub label {
  my $self = shift;
  $self->acctnum . '@'. $self->alarm_station->stationname. #?
    ' ('. $self->alarm_system->systemname. ' '. $self->alarm_type->typename. ')'
  ;
}

sub search_sql {
  my($class, $string) = @_;
  $class->search_sql_field('acctnum', $string);
}

=item insert

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

=item delete

Delete this record from the database.

=item replace OLD_RECORD

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

=cut

sub preinsert_hook_first  { shift->_inline_add(@_); }
sub prereplace_hook_first { shift->_inline_add(@_); }

sub _inline_add {
  my $self = shift;

  my $agentnum = $self->cust_svc->cust_pkg->cust_main->agentnum;

  if ( $self->alarmsystemnum == -1 ) {
    my $alarm_system = new FS::alarm_system {
      'agentnum'   => $agentnum,
      'systemname' => $self->alarmsystemnum_systemname,
    };
    my $error = $alarm_system->insert;
    return $error if $error;
    $self->alarmsystemnum($alarm_system->alarmsystemnum);
  }

  if ( $self->alarmtypenum == -1 ) {
    my $alarm_type = new FS::alarm_type {
      'agentnum' => $agentnum,
      'inputs'   => $self->alarmtypenum_inputs,
      'outputs'  => $self->alarmtypenum_outputs,
    };
    my $error = $alarm_type->insert;
    return $error if $error;
    $self->alarmtypenum($alarm_type->alarmtypenum);
  }

  if ( $self->alarmstationnum == -1 ) {
    my $alarm_station = new FS::alarm_station {
      'agentnum'    => $agentnum,
      'stationname' => $self->alarmstationnum_stationname,
    };
    my $error = $alarm_station->insert;
    return $error if $error;
    $self->alarmstationnum($alarm_station->alarmstationnum)
  }

  '';
}

=item check

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

=cut

sub check {
  my $self = shift;

  my $x = $self->setfixed;
  return $x unless ref $x;

  my $iso3166 = $self->cust_main->ship_location->country();

  my $error =
    $self->ut_numbern('svcnum')
    || $self->ut_text('acctnum')
    || $self->ut_alphan('_password')
    || $self->ut_textn('location')
    || $self->ut_numbern('cs_receiver')
    || $self->ut_phonen('cs_phonenum', $iso3166)
    || $self->ut_alphan('serialnum')
    || $self->ut_foreign_key('alarmsystemnum',  'alarm_system',  'systemnum')
    || $self->ut_foreign_key('alarmtypenum',    'alarm_type',    'typenum')
    || $self->ut_foreign_key('alarmstationnum', 'alarm_station', 'stationnum')
  ;
  return $error if $error;

  #really just an signed int, but to discourage storing other data (e.g. phone)
  return 'CS Receiver must be 9 digits or less'
    if $self->cs_receiver =~ /\d{10}/;

  $self->SUPER::check;
}

=back

=head1 SEE ALSO

L<FS::Record>, L<FS::svc_Common>, schema.html from the base documentation.

=cut

1;