#------------------------------------------------------------
# Copyright (C) 2006 RoyaltyShare, Inc.   All Rights Reserved
# $Id$
#------------------------------------------------------------
package RPS::Statement::Mechanical::StatementItemList;

use strict;
use warnings;
use Carp;

use Data::Dumper;
use lib '/app/tools/common/lib';
use Common::Assert;

use lib '/app/tools/rps/lib';

use Common::FormObject;
use base 'Common::FormObject';

sub _init {
    my ( $self, %args ) = @_;

    $self->SUPER::_init(%args);

    my $statementID    = $args{mechanicalStatementID};
    my $trackLicenseID = $args{trackLicenseID};

    $self->{MechanicalStatementItem} = [];
    if ($statementID) {
        my $collection = $self->_getStatementItemCollection( $statementID, $trackLicenseID );

        while ( $collection->hasNext() ) {
            my $obj = $collection->next();

            my $item = $self->_getStatementItem($obj);
            if ($item) {
                push @{ $self->{MechanicalStatementItem} }, $item;
            }
        }
    }

    return $self;
}

sub _getStatementItemCollection {
    my ( $self, $statementID, $trackLicenseID ) = @_;
    assert( 0, 'override this' );
}

sub _getStatementItem {
    my ( $self, $dbItem ) = @_;
    assert( 0, 'override this' );

    # !!! HFA override should return undef if amount_paid <= 0
}

sub getList {
    my ($self) = @_;

    return $self->{MechanicalStatementItem};
}

sub numItems {
    my ($self) = @_;
    return scalar @{ $self->{MechanicalStatementItem} };
}

1;