summaryrefslogtreecommitdiff
path: root/FS
diff options
context:
space:
mode:
authorIvan Kohler <ivan@freeside.biz>2013-12-09 14:43:35 -0800
committerIvan Kohler <ivan@freeside.biz>2013-12-09 14:43:35 -0800
commita3bc8ae55eb80d4517c64eaeb4b08df3ddf867f6 (patch)
treed764e93363c97d18e05dcff46beac4c7a4f59ece /FS
parent49a0b5d01cfa15be787539edfff5ba4875ca3c3e (diff)
alarm systems, types, central stations, RT#25994
Diffstat (limited to 'FS')
-rw-r--r--FS/FS/alarm_station.pm117
-rw-r--r--FS/FS/alarm_system.pm117
-rw-r--r--FS/FS/alarm_type.pm131
-rw-r--r--FS/t/alarm_station.t5
-rw-r--r--FS/t/alarm_system.t5
-rw-r--r--FS/t/alarm_type.t5
6 files changed, 380 insertions, 0 deletions
diff --git a/FS/FS/alarm_station.pm b/FS/FS/alarm_station.pm
new file mode 100644
index 000000000..ee173e58b
--- /dev/null
+++ b/FS/FS/alarm_station.pm
@@ -0,0 +1,117 @@
+package FS::alarm_station;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record; # qw( qsearch qsearchs );
+use FS::agent;
+
+=head1 NAME
+
+FS::alarm_station - Object methods for alarm_station records
+
+=head1 SYNOPSIS
+
+ use FS::alarm_station;
+
+ $record = new FS::alarm_station \%hash;
+ $record = new FS::alarm_station { 'column' => 'value' };
+
+ $error = $record->insert;
+
+ $error = $new_record->replace($old_record);
+
+ $error = $record->delete;
+
+ $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::alarm_station object represents an alarm system central station.
+FS::alarm_station inherits from FS::Record. The following fields are currently
+supported:
+
+=over 4
+
+=item alarmstationnum
+
+primary key
+
+=item agentnum
+
+agentnum
+
+=item stationname
+
+stationname
+
+=item disabled
+
+disabled
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new central station. To add the central station to the database, see
+L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to. You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+sub table { 'alarm_station'; }
+
+=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.
+
+=item check
+
+Checks all fields to make sure this is a valid central station. 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 $error =
+ $self->ut_numbern('alarmstationnum')
+ || $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
+ || $self->ut_text('stationname')
+ || $self->ut_enum('disabled', ['', 'Y'])
+ ;
+ return $error if $error;
+
+ $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::svc_alarm>, L<FS::Record>
+
+=cut
+
+1;
+
diff --git a/FS/FS/alarm_system.pm b/FS/FS/alarm_system.pm
new file mode 100644
index 000000000..8320384e6
--- /dev/null
+++ b/FS/FS/alarm_system.pm
@@ -0,0 +1,117 @@
+package FS::alarm_system;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record; # qw( qsearch qsearchs );
+use FS::agent;
+
+=head1 NAME
+
+FS::alarm_system - Object methods for alarm_system records
+
+=head1 SYNOPSIS
+
+ use FS::alarm_system;
+
+ $record = new FS::alarm_system \%hash;
+ $record = new FS::alarm_system { 'column' => 'value' };
+
+ $error = $record->insert;
+
+ $error = $new_record->replace($old_record);
+
+ $error = $record->delete;
+
+ $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::alarm_system object represents an alarm system vendor. FS::alarm_system
+inherits from FS::Record. The following fields are currently supported:
+
+=over 4
+
+=item alarmsystemnum
+
+primary key
+
+=item agentnum
+
+agentnum
+
+=item systemname
+
+systemname
+
+=item disabled
+
+disabled
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new vendor. To add the vendor to the database, see L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to. You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+# the new method can be inherited from FS::Record, if a table method is defined
+
+sub table { 'alarm_system'; }
+
+=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.
+
+=item check
+
+Checks all fields to make sure this is a valid vendor. 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 $error =
+ $self->ut_numbern('alarmsystemnum')
+ || $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
+ || $self->ut_text('systemname')
+ || $self->ut_enum('disabled', ['', 'Y'])
+ ;
+ return $error if $error;
+
+ $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::svc_alarm>, L<FS::Record>
+
+=cut
+
+1;
+
diff --git a/FS/FS/alarm_type.pm b/FS/FS/alarm_type.pm
new file mode 100644
index 000000000..f225bec27
--- /dev/null
+++ b/FS/FS/alarm_type.pm
@@ -0,0 +1,131 @@
+package FS::alarm_type;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record; # qw( qsearch qsearchs );
+use FS::agent;
+
+=head1 NAME
+
+FS::alarm_type - Object methods for alarm_type records
+
+=head1 SYNOPSIS
+
+ use FS::alarm_type;
+
+ $record = new FS::alarm_type \%hash;
+ $record = new FS::alarm_type { 'column' => 'value' };
+
+ $error = $record->insert;
+
+ $error = $new_record->replace($old_record);
+
+ $error = $record->delete;
+
+ $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::alarm_type object represents an alarm system type (number of inputs and
+outputs). FS::alarm_type inherits from FS::Record. The following fields are
+currently supported:
+
+=over 4
+
+=item alarmtypenum
+
+primary key
+
+=item agentnum
+
+agentnum
+
+=item inputs
+
+inputs
+
+=item outputs
+
+outputs
+
+=item disabled
+
+disabled
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new type. To add the type to the database, see L<"insert">.
+
+Note that this stores the hash reference, not a distinct copy of the hash it
+points to. You can ask the object for a copy with the I<hash> method.
+
+=cut
+
+sub table { 'alarm_type'; }
+
+=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.
+
+=item check
+
+Checks all fields to make sure this is a valid type. 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 $error =
+ $self->ut_numbern('alarmtypenum')
+ || $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum')
+ || $self->ut_number('inputs')
+ || $self->ut_number('outputs')
+ || $self->ut_enum('disabled', ['', 'Y'])
+ ;
+ return $error if $error;
+
+ $self->SUPER::check;
+}
+
+=item typename
+
+inputs x outputs
+
+=cut
+
+sub typename {
+ my $self = shift;
+ $self->inputs. 'x'. $self->outputs;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::svc_alarm>, L<FS::Record>
+
+=cut
+
+1;
+
diff --git a/FS/t/alarm_station.t b/FS/t/alarm_station.t
new file mode 100644
index 000000000..9fc36f827
--- /dev/null
+++ b/FS/t/alarm_station.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::alarm_station;
+$loaded=1;
+print "ok 1\n";
diff --git a/FS/t/alarm_system.t b/FS/t/alarm_system.t
new file mode 100644
index 000000000..f835c4a2b
--- /dev/null
+++ b/FS/t/alarm_system.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::alarm_system;
+$loaded=1;
+print "ok 1\n";
diff --git a/FS/t/alarm_type.t b/FS/t/alarm_type.t
new file mode 100644
index 000000000..2bbdf6302
--- /dev/null
+++ b/FS/t/alarm_type.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::alarm_type;
+$loaded=1;
+print "ok 1\n";