adding taxclass table
authorivan <ivan>
Tue, 19 Feb 2008 09:16:25 +0000 (09:16 +0000)
committerivan <ivan>
Tue, 19 Feb 2008 09:16:25 +0000 (09:16 +0000)
FS/FS.pm
FS/FS/part_pkg_taxclass.pm [new file with mode: 0644]
FS/MANIFEST
FS/t/part_pkg_taxclass.t [new file with mode: 0644]

index e0c8204..6fa6faa 100644 (file)
--- a/FS/FS.pm
+++ b/FS/FS.pm
@@ -165,6 +165,8 @@ L<FS::pkg_class> - Package class class
 
 L<FS::part_pkg> - Package definition class
 
+L<FS::part_pkg_taxclass> - Tax class class
+
 L<FS::part_pkg_option> - Package definition option class
 
 L<FS::pkg_svc> - Class linking package definitions (see L<FS::part_pkg>) with
diff --git a/FS/FS/part_pkg_taxclass.pm b/FS/FS/part_pkg_taxclass.pm
new file mode 100644 (file)
index 0000000..341be0e
--- /dev/null
@@ -0,0 +1,126 @@
+package FS::part_pkg_taxclass;
+
+use strict;
+use vars qw( @ISA );
+use FS::Record qw( qsearch qsearchs );
+
+@ISA = qw(FS::Record);
+
+=head1 NAME
+
+FS::part_pkg_taxclass - Object methods for part_pkg_taxclass records
+
+=head1 SYNOPSIS
+
+  use FS::part_pkg_taxclass;
+
+  $record = new FS::part_pkg_taxclass \%hash;
+  $record = new FS::part_pkg_taxclass { 'column' => 'value' };
+
+  $error = $record->insert;
+
+  $error = $new_record->replace($old_record);
+
+  $error = $record->delete;
+
+  $error = $record->check;
+
+=head1 DESCRIPTION
+
+An FS::part_pkg_taxclass object represents a tax class.  FS::part_pkg_taxclass
+inherits from FS::Record.  The following fields are currently supported:
+
+=over 4
+
+=item taxclassnum
+
+Primary key
+
+=item taxclass
+
+Tax class
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new tax class.  To add the tax class 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 { 'part_pkg_taxclass'; }
+
+=item insert
+
+Adds this record to the database.  If there is an error, returns the error,
+otherwise returns false.
+
+=cut
+
+# the insert method can be inherited from FS::Record
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+# the delete method can be inherited from FS::Record
+
+=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
+
+# the replace method can be inherited from FS::Record
+
+=item check
+
+Checks all fields to make sure this is a valid tax class.  If there is
+an error, returns the error, otherwise returns false.  Called by the insert
+and replace methods.
+
+=cut
+
+# the check method should currently be supplied - FS::Record contains some
+# data checking routines
+
+sub check {
+  my $self = shift;
+
+  my $error = 
+    $self->ut_numbern('serial')
+    || $self->ut_number('taxclassnum')
+    || $self->ut_text('taxclass')
+  ;
+  return $error if $error;
+
+  $self->SUPER::check;
+}
+
+=back
+
+=head1 BUGS
+
+Other tables (cust_main_county, part_pkg, agent_payment_gateway) have a text
+taxclass instead of a key to this table.
+
+=head1 SEE ALSO
+
+L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+
index eb2fd89..635bc04 100644 (file)
@@ -392,3 +392,5 @@ FS/acct_rt_transaction.pm
 t/acct_rt_transaction.t
 FS/cust_pay_pending.pm
 t/cust_pay_pending.t
+FS/part_pkg_taxclass.pm
+t/part_pkg_taxclass.t
diff --git a/FS/t/part_pkg_taxclass.t b/FS/t/part_pkg_taxclass.t
new file mode 100644 (file)
index 0000000..bbe4073
--- /dev/null
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::part_pkg_taxclass;
+$loaded=1;
+print "ok 1\n";