svc_cable service have a single serial / MAC / model, not one-to-many devices like...

[freeside.git] / FS / FS / cable_model.pm

diff --git a/FS/FS/cable_model.pm b/FS/FS/cable_model.pm
new file mode 100644 (file)
index 0000000..7f662de
--- /dev/null
+++ b/FS/FS/cable_model.pm
@@ -0,0 +1,109 @@
+package FS::cable_model;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record qw( qsearch qsearchs );
+
+=head1 NAME
+
+FS::cable_model - Object methods for cable_model records
+
+=head1 SYNOPSIS
+
+  use FS::cable_model;
+
+  $record = new FS::cable_model \%hash;
+  $record = new FS::cable_model { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::cable_model object represents a cable device model.  FS::cable_model
+inherits from FS::Record.  The following fields are currently supported:
+
+=over 4
+
+=item modelnum
+
+primary key
+
+=item model_name
+
+model_name
+
+=item disabled
+
+disabled
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new record.  To add the record 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 { 'cable_model'; }
+
+=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 record.  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('modelnum')
+    || $self->ut_text('model_name')
+    || $self->ut_enum('disabled', [ '', 'Y'] )
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+