X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=site_perl%2Ftable_template-svc.pm;h=40c9ed9b55a1fb461e88eecce2f450955ff1c54b;hp=a8cbaed5e5ef6f13120ec3c68497d5d277517de1;hb=7613e14fd13aabb2a44bb26ca8640053f44930ea;hpb=982a174dd0dc4b6f56d3008fa45835dfcdd6869a

diff --git a/site_perl/table_template-svc.pm b/site_perl/table_template-svc.pm
index a8cbaed5e..40c9ed9b5 100644
--- a/site_perl/table_template-svc.pm
+++ b/site_perl/table_template-svc.pm
@@ -1,107 +1,177 @@
-#!/usr/local/bin/perl -Tw
-#
-# ivan@voicenet.com 97-jul-21
-
 package FS::svc_table;
 
 use strict;
-use Exporter;
-use FS::Record qw(fields qsearchs);
+use vars qw(@ISA);
+#use FS::Record qw( qsearch qsearchs );
+use FS::svc_Common;
+use FS::cust_svc;
 
-@FS::svc_table::ISA = qw(FS::Record Exporter);
+@ISA = qw(svc_Common);
 
-# Usage: $record = create FS::svc_table ( \%hash );
-#        $record = create FS::svc_table ( { field=>value, ... } );
-sub create {
-  my($proto,$hashref)=@_;
+=head1 NAME
 
-  my($field);
-  foreach $field (fields('svc_table')) {
-    $hashref->{$field}='' unless defined $hashref->{$field};
-  }
+FS::table_name - Object methods for table_name records
 
-  $proto->new('svc_table',$hashref);
+=head1 SYNOPSIS
 
-}
+  use FS::table_name;
 
-# Usage: $error = $record -> insert;
-sub insert {
-  my($self)=@_;
-  my($error);
+  $record = new FS::table_name \%hash;
+  $record = new FS::table_name { 'column' => 'value' };
 
-  local $SIG{HUP} = 'IGNORE';
-  local $SIG{INT} = 'IGNORE';
-  local $SIG{QUIT} = 'IGNORE';
-  local $SIG{TERM} = 'IGNORE';
-  local $SIG{TSTP} = 'IGNORE';
+  $error = $record->insert;
 
-  $error=$self->check;
-  return $error if $error;
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+  $error = $record->suspend;
+
+  $error = $record->unsuspend;
+
+  $error = $record->cancel;
+
+=head1 DESCRIPTION
+
+An FS::table_name object represents an example.  FS::table_name inherits from
+FS::svc_Common.  The following fields are currently supported:
+
+=over 4
+
+=item field - description
+
+=back
+
+=head1 METHODS
 
-  $error = $self->add;
+=over 4
+
+=item new HASHREF
+
+Creates a new example.  To add the example 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 { 'table_name'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be 
+defined.  An FS::cust_svc record will be created and inserted.
+
+=cut
+
+sub insert {
+  my $self = shift;
+  my $error;
+
+  $error = $self->SUPER::insert;
   return $error if $error;
 
-  ''; #no error
+  '';
 }
 
-# Usage: $error = $record -> delete;
+=item delete
+
+Delete this record from the database.
+
+=cut
+
 sub delete {
-  my($self)=@_;
-  my($error);
+  my $self = shift;
+  my $error;
 
-  $error = $self->del;
+  $error = $self->SUPER::delete;
   return $error if $error;
 
+  '';
 }
 
-# Usage: $error = $newrecord -> replace($oldrecord)
-sub replace {
-  my($new,$old)=@_;
-  my($error);
 
-  return "(Old) Not a svc_table record!" unless $old->table eq "svc_table";
-  return "Can't change svcnum!"
-    unless $old->getfield('svcnum') eq $new->getfield('svcnum');
+=item replace OLD_RECORD
 
-  $error=$new->check;
-  return $error if $error;
+Replaces the OLD_RECORD with this one in the database.  If there is an error,
+returns the error, otherwise returns false.
+
+=cut
 
-  $error = $new->rep($old);
+sub replace {
+  my ( $new, $old ) = ( shift, shift );
+  my $error;
+
+  $error = $new->SUPER::replace($old);
   return $error if $error;
 
-  ''; #no error
+  '';
 }
 
-# Usage: $error = $record -> suspend;
-sub suspend {
-  ''; #no error (stub)
-}
+=item suspend
 
-# Usage: $error = $record -> unsuspend;
-sub unsuspend {
-  ''; #no error (stub)
-}
+Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
 
-# Usage: $error = $record -> cancel;
-sub cancel {
-  ''; #no error (stub)
-}
+=item unsuspend
+
+Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
+
+=item cancel
+
+Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
+
+=item check
+
+Checks all fields to make sure this is a valid example.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and repalce methods.
+
+=cut
 
-# Usage: $error = $record -> check;
 sub check {
-  my($self)=@_;
-  return "Not a svc_table record!" unless $self->table eq "svc_table";
-  my($recref) = $self->hashref;
+  my $self = shift;
 
-  $recref->{svcnum} =~ /^(\d+)$/ or return "Illegal svcnum";
-  $recref->{svcnum} = $1;
-  return "Unknown svcnum" unless
-    qsearchs('cust_svc',{'svcnum'=> $recref->{svcnum} } );
+  my $x = $self->setfixed;
+  return $x unless ref($x);
+  my $part_svc = $x;
 
-  #DATA CHECKS GO HERE!
 
   ''; #no error
 }
 
+=back
+
+=head1 VERSION
+
+$Id: table_template-svc.pm,v 1.4 1998-12-30 00:30:48 ivan Exp $
+
+=head1 BUGS
+
+The author forgot to customize this manpage.
+
+=head1 SEE ALSO
+
+L<FS::svc_Common>, L<FS::Record>, L<FS::cust_svc>, L<FS::part_svc>,
+L<FS::cust_pkg>, schema.html from the base documentation.
+
+=head1 HISTORY
+
+ivan@voicenet.com 97-jul-21
+
+$Log: table_template-svc.pm,v $
+Revision 1.4  1998-12-30 00:30:48  ivan
+svc_ stuff is more properly OO - has a common superclass FS::svc_Common
+
+Revision 1.2  1998/11/15 04:33:01  ivan
+updates for newest versoin
+
+
+=cut
+
 1;