org.kuali.kfs.gl.batch
Class NominalActivityClosingHelper

java.lang.Object
  org.kuali.kfs.gl.batch.NominalActivityClosingHelper

public class NominalActivityClosingHelper
extends Object

This class helps generate the entries for the nominal activity closing year end job.

Constructor Summary

NominalActivityClosingHelper(Integer fiscalYear, Date transactionDate, org.kuali.rice.kns.service.ParameterService parameterService, org.kuali.rice.kns.service.KualiConfigurationService configurationService)
Constructs a NominalActivityClosingHelper

Method Summary

void	addNominalClosingJobParameters(Map nominalClosingJobParameters) Adds the job parameters used to generate the origin entries to the given map
OriginEntryFull	generateActivityEntry(Balance balance, Integer sequenceNumber) Generates an origin entry that will summarize close out of nominal items (income and expense)
OriginEntryFull	generateOffset(Balance balance, Integer sequenceNumber) Genereates an origin entry to update a fund balance as a result of closing income and expense
Integer	getNonFatalErrorCount() Returns the count of non-fatal errors encountered during the process by this helper

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NominalActivityClosingHelper

public NominalActivityClosingHelper(Integer fiscalYear,
                                    Date transactionDate,
                                    org.kuali.rice.kns.service.ParameterService parameterService,
                                    org.kuali.rice.kns.service.KualiConfigurationService configurationService)

Constructs a NominalActivityClosingHelper

Parameters:

fiscalYear - the fiscal year this job is being run for

transactionDate - the transaction date that origin entries should hit the ledger

parameterService - an implementation of the ParameterService

configurationService - an implementation of the KualiConfigurationService

Method Detail

generateActivityEntry

public OriginEntryFull generateActivityEntry(Balance balance,
                                             Integer sequenceNumber)
                                      throws FatalErrorException

Generates an origin entry that will summarize close out of nominal items (income and expense)

Parameters:

balance - the balance this activity closing entry needs to be created for

sequenceNumber - the sequence number of the origin entry

Returns:

an origin entry which will close out nominal activity on a balance

Throws:

FatalErrorException - thrown if the given balance lacks an object type code

generateOffset

public OriginEntryFull generateOffset(Balance balance,
                                      Integer sequenceNumber)
                               throws FatalErrorException

Genereates an origin entry to update a fund balance as a result of closing income and expense

Parameters:

balance - the balance this offset needs to be created for

sequenceNumber - the sequence number of the origin entry full

Returns:

an origin entry which will offset the nominal closing activity

Throws:

FatalErrorException - thrown if the given balance lacks an object type code

addNominalClosingJobParameters

public void addNominalClosingJobParameters(Map nominalClosingJobParameters)

Adds the job parameters used to generate the origin entries to the given map

Parameters:

nominalClosingJobParameters - a map of batch job parameters to add nominal activity closing parameters to

getNonFatalErrorCount

public Integer getNonFatalErrorCount()

Returns the count of non-fatal errors encountered during the process by this helper

Returns:

the count of non-fatal errors