historical (immutable) invoice details about services and other history infrastructure

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

diff --git a/FS/FS/h_cust_svc.pm b/FS/FS/h_cust_svc.pm
new file mode 100644 (file)
index 0000000..9ef60fd
--- /dev/null
+++ b/FS/FS/h_cust_svc.pm
@@ -0,0 +1,84 @@
+package FS::h_cust_svc;
+
+use strict;
+use vars qw( @ISA $DEBUG );
+use Carp;
+use FS::Record qw(qsearchs);
+use FS::h_Common;
+use FS::cust_svc;
+
+@ISA = qw( FS::h_Common FS::cust_svc );
+
+$DEBUG = 0;
+
+sub table { 'h_cust_svc'; }
+
+=head1 NAME
+
+FS::h_cust_svc - Object method for h_cust_svc objects
+
+=head1 SYNOPSIS
+
+=head1 DESCRIPTION
+
+An FS::h_cust_svc object  represents a historical service.  FS::h_cust_svc
+inherits from FS::h_Common and FS::cust_svc.
+
+=head1 METHODS
+
+=over 4
+
+=item label END_TIMESTAMP [ START_TIMESTAMP ] 
+
+Returns a list consisting of:
+- The name of this historical service (from part_svc)
+- A meaningful identifier (username, domain, or mail alias)
+- The table name (i.e. svc_domain) for this historical service
+
+=cut
+
+sub label {
+  my $self = shift;
+  carp "FS::h_cust_svc::label called on $self" if $DEBUG;
+  my $svc_x = $self->h_svc_x(@_)
+    or die "can't find h_". $self->part_svc->svcdb. '.svcnum '. $self->svcnum;
+  $self->_svc_label($svc_x, @_);
+}
+
+=item h_svc_x END_TIMESTAMP [ START_TIMESTAMP ] 
+
+Returns the FS::h_svc_XXX object for this service as of END_TIMESTAMP (i.e. an
+FS::h_svc_acct object or FS::h_svc_domain object, etc.) and (optionally) not
+cancelled before START_TIMESTAMP.
+
+=cut
+
+#false laziness w/cust_pkg::h_cust_svc
+sub h_svc_x {
+  my $self = shift;
+  my $svcdb = $self->part_svc->svcdb;
+  #if ( $svcdb eq 'svc_acct' && $self->{'_svc_acct'} ) {
+  #  $self->{'_svc_acct'};
+  #} else {
+    warn "requiring FS/h_$svcdb.pm" if $DEBUG;
+    require "FS/h_$svcdb.pm";
+    qsearchs( "h_$svcdb",
+              { 'svcnum'       => $self->svcnum, },
+              "FS::h_$svcdb"->sql_h_search(@_),
+            );
+  #}
+}
+
+=back
+
+=head1 BUGS
+
+=head1 SEE ALSO
+
+L<FS::h_Common>, L<FS::cust_svc>, L<FS::Record>, schema.html from the base
+documentation.
+
+=cut
+
+1;
+