NAME

Payroll::US

SYNOPSIS

use Payroll::US;

my $usPayroll = Payroll::US->new();
if ($usPayroll->didErrorOccur())
{
  die $usPayroll->errorMessage();
}

my $result = Payroll::XML::OutData->new(periodNames => \%periodNames);
my @result = ();

eval { @result = $usPayroll->process(person => $person, date => $date, period => $period,
                           info => \%countryInfo);
if ($@)
{
  die "$@";
}

DESCRIPTION

This is the base package for the Payroll::US Modules.

Exported FUNCTIONS

scalar new()

Creates a new instance of the object.
takes:

bool isValid(void)

Returns 0 or 1 to indicate if the object is valid.  The error will be available via errorMessage().

void setError(errorString)

Sets error = 1 and $self->{errorString} = errorString.
returns nothing

scalar didErrorOccur(void)

Returns the value of error.

scalar errorMessage(void)

Returns the value of errorString.

@items process(person, date, period, info, round)

info contains the information related to this country for the specified person.
person represents the person object in the Data structure.
date is the date specified in the XML document.
period is the period specified in the XML document.
round specifies whether to round the result or not.

Returns: the items array of name,value entries created.

AUTHOR

Xperience, Inc. (mailto:admin@pcxperience.com)

SEE ALSO

perl(1), Payroll(3)