package FS::cust_bill_pkg_detail;

use strict;
use vars qw( @ISA $me $DEBUG );
use FS::Record qw( qsearch qsearchs dbdef );
use FS::cust_bill_pkg;

@ISA = qw(FS::Record);
$me = '[ FS::cust_bill_pkg_detail ]';
$DEBUG = 0;

=head1 NAME

FS::cust_bill_pkg_detail - Object methods for cust_bill_pkg_detail records

=head1 SYNOPSIS

  use FS::cust_bill_pkg_detail;

  $record = new FS::cust_bill_pkg_detail \%hash;
  $record = new FS::cust_bill_pkg_detail { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::cust_bill_pkg_detail object represents additional detail information for
an invoice line item (see L<FS::cust_bill_pkg>).  FS::cust_bill_pkg_detail
inherits from FS::Record.  The following fields are currently supported:

=over 4

=item detailnum - primary key

=item billpkgnum - link to cust_bill_pkg

=item detail - detail description

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new line item detail.  To add the line item detail 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 { 'cust_bill_pkg_detail'; }

=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 line item detail.  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;

  $self->ut_numbern('detailnum')
    || $self->ut_foreign_key('billpkgnum', 'cust_bill_pkg', 'billpkgnum')
    || $self->ut_enum('format', [ '', 'C' ] )
    || $self->ut_text('detail')
    || $self->SUPER::check
    ;

}

# _upgrade_data
#
# Used by FS::Upgrade to migrate to a new database.

sub _upgrade_data { # class method

  my ($class, %opts) = @_;

  warn "$me upgrading $class\n" if $DEBUG;

  if ( defined( dbdef->table($class->table)->column('billpkgnum') ) &&
       defined( dbdef->table($class->table)->column('invnum') ) &&
       defined( dbdef->table($class->table)->column('pkgnum') ) 
  ) {

    warn "$me Checking for unmigrated invoice line item details\n" if $DEBUG;

    my @cbpd = qsearch({ 'table'   => $class->table,
                         'hashref' => {},
                         'extra_sql' => 'WHERE invnum IS NOT NULL AND '.
                                        'pkgnum IS NOT NULL',
                      });

    if (scalar(@cbpd)) {
      warn "$me Found unmigrated invoice line item details\n" if $DEBUG;

      foreach my $cbpd ( @cbpd ) {
        my $detailnum = $cbpd->detailnum;
        warn "$me Contemplating detail $detailnum\n" if $DEBUG > 1;
        my $cust_bill_pkg =
          qsearchs({ 'table' => 'cust_bill_pkg',
                     'hashref' => { 'invnum' => $cbpd->invnum,
                                    'pkgnum' => $cbpd->pkgnum,
                                  },
                     'order_by' => 'ORDER BY billpkgnum LIMIT 1',
                  });
        if ($cust_bill_pkg) {
          $cbpd->billpkgnum($cust_bill_pkg->billpkgnum);
          $cbpd->invnum('');
          $cbpd->pkgnum('');
          my $error = $cbpd->replace;

          warn "*** WARNING: error replacing line item detail ".
               "(cust_bill_pkg_detail) $detailnum: $error ***\n"
            if $error;
        } else {
          warn "Found orphaned line item detail $detailnum during upgrade.\n";
        }

      } # foreach $cbpd

    } # if @cbpd

  } # if billpkgnum, invnum, and pkgnum columns defined

  '';

}                         

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::cust_bill_pkg>, L<FS::Record>, schema.html from the base documentation.

=cut

1;