org.kuali.ole.gl.batch.service.impl

Class ScrubberProcessImpl

java.lang.Object

org.kuali.ole.gl.batch.service.impl.ScrubberProcessImpl

All Implemented Interfaces:

ScrubberProcess

public class ScrubberProcessImpl
extends Object
implements ScrubberProcess

This class has the logic for the scrubber. It is required because the scrubber process needs instance variables. Instance variables in a spring service are shared between all code calling the service. This will make sure each run of the scrubber has it's own instance variables instead of being shared.

Field Summary

Fields

Modifier and Type	Field and Description
protected AccountingCycleCachingService	accountingCycleCachingService
protected String	batchFileDirectoryName
protected org.kuali.rice.krad.service.BusinessObjectService	businessObjectService
protected String	capitalizationDescription
protected boolean	collectorMode Whether this instance is being used to support the scrubbing of a collector batch
protected org.kuali.rice.core.api.config.property.ConfigurationService	configurationService
protected static String	COST_SHARE_CODE
protected static int	COST_SHARE_ENCUMBRANCE_ENTRY_MAXLENGTH
protected static String	COST_SHARE_TRANSFER_ENTRY_IND
protected String	costShareDescription
protected org.kuali.rice.core.api.datetime.DateTimeService	dateTimeService
protected static int	DEMERGER_TRANSACTION_LEDGET_ENTRY_DESCRIPTION
protected ReportWriterService	demergerRemovedTransactionsListingReportWriterService
protected DemergerReportData	demergerReport
protected ReportWriterService	demergerReportWriterService
protected String	errorFile
protected String	expiredFile
protected FlexibleOffsetAccountService	flexibleOffsetAccountService
protected String	inputFile
protected LedgerSummaryReport	ledgerSummaryReport
protected String	liabilityDescription
protected static int	OFFSET_MESSAGE_MAXLENGTH
protected String	offsetDescription
protected String	offsetString
protected PrintStream	OUTPUT_ERR_FILE_ps
protected PrintStream	OUTPUT_EXP_FILE_ps
protected PrintStream	OUTPUT_GLE_FILE_ps
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	parameterService
protected org.kuali.rice.krad.service.PersistenceService	persistenceService
protected DocumentNumberAwareReportWriterService	preScrubberReportWriterService
protected PreScrubberService	preScrubberService
protected Calendar	runCal
protected Date	runDate
protected RunDateService	runDateService
protected ReportWriterService	scrubberBadBalanceListingReportWriterService
protected DocumentNumberAwareReportWriterService	scrubberLedgerReportWriterService
protected DocumentNumberAwareReportWriterService	scrubberListingReportWriterService
protected ScrubberReportData	scrubberReport
protected Map<Transaction,List<Message>>	scrubberReportErrors
protected DocumentNumberAwareReportWriterService	scrubberReportWriterService
protected ScrubberValidator	scrubberValidator
protected org.kuali.rice.core.api.util.type.KualiDecimal	scrubCostShareAmount
protected static String	TRANSACTION_TYPE_CAPITALIZATION
protected static String	TRANSACTION_TYPE_COST_SHARE
protected static String	TRANSACTION_TYPE_COST_SHARE_ENCUMBRANCE
protected static String	TRANSACTION_TYPE_LIABILITY
protected static String	TRANSACTION_TYPE_OFFSET
protected static String	TRANSACTION_TYPE_OTHER
protected static String	TRANSACTION_TYPE_TRANSFER
protected List<Message>	transactionErrors
protected String	transferDescription
protected org.kuali.ole.gl.batch.service.impl.ScrubberProcessImpl.UnitOfWorkInfo	unitOfWork
protected UniversityDate	universityRunDate
protected Map<OriginEntryInformation,OriginEntryInformation>	unscrubbedToScrubbedEntries
protected String	validFile

Constructor Summary

Constructors

Constructor and Description
ScrubberProcessImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addTransactionError(String errorMessage, String errorValue, int type) Add an error message to the list of messages for this transaction
Date	calculateRunDate(Date currentDate) This method modifies the run date if it is before the cutoff time specified by the RunTimeService See KULRNE-70 This method is public to facilitate unit testing
protected String	checkAndSetTransactionTypeCostShare(String financialBalanceTypeCode, String desc, String currentValidLine)
protected boolean	checkingBypassEntry(String financialBalanceTypeCode, String desc, DemergerReportData demergerReport)
protected void	createOutputEntry(OriginEntryInformation entry, PrintStream ps)
protected void	createOutputEntry(String line, PrintStream ps)
protected org.kuali.ole.gl.batch.service.impl.ScrubberProcessImpl.TransactionError	generateCostShareEncumbranceEntries(OriginEntryInformation scrubbedEntry, ScrubberReportData scrubberReport) The purpose of this method is to generate a "Cost Share Encumbrance" transaction for the current transaction and its offset.
protected org.kuali.ole.gl.batch.service.impl.ScrubberProcessImpl.TransactionError	generateCostShareEntries(OriginEntryInformation scrubbedEntry, ScrubberReportData scrubberReport) Generates a cost share entry and offset for the given entry and saves both to the valid group
protected void	generateDemergerRemovedTransactionsReport(String errorFileName)
protected boolean	generateOffset(OriginEntryInformation scrubbedEntry, ScrubberReportData scrubberReport) The purpose of this method is to build the actual offset transaction.
protected void	generateScrubberBlankBalanceTypeCodeReport(String inputFileName) Generates the scrubber report that lists out the input origin entries with blank balance type codes.
protected void	generateScrubberTransactionListingReport(String documentNumber, String inputFileName) Generates the scrubber listing report for the GLCP document
AccountingCycleCachingService	getAccountingCycleCachingService() Gets the accountingCycleCachingService attribute.
org.kuali.rice.core.api.config.property.ConfigurationService	getConfigurationService() Gets the configurationService attribute.
org.kuali.rice.core.api.datetime.DateTimeService	getDateTimeService() Gets the dateTimeService attribute.
ReportWriterService	getDemergerRemovedTransactionsListingReportWriterService() Gets the demergerRemovedTransactionsListingReportWriterService attribute.
ReportWriterService	getDemergerReportWriterService() Gets the demergerReportWriterService attribute.
FlexibleOffsetAccountService	getFlexibleOffsetAccountService() Gets the flexibleOffsetAccountService attribute.
protected ObjectCode	getFundBalanceObjectCode(String fundBalanceCode, OriginEntryFull originEntryFull) This method...
protected String	getOffsetMessage() Generate the offset message with the flag at the end
org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Gets the parameterService attribute.
org.kuali.rice.krad.service.PersistenceService	getPersistenceService() Gets the persistenceService attribute.
PreScrubberService	getPreScrubberService() Gets the preScrubberService attribute.
RunDateService	getRunDateService() Gets the runDateService attribute.
ReportWriterService	getScrubberBadBalanceListingReportWriterService() Gets the scrubberBadBalanceListingReportWriterService attribute.
DocumentNumberAwareReportWriterService	getScrubberLedgerReportWriterService() Gets the scrubberLedgerReportWriterService attribute.
DocumentNumberAwareReportWriterService	getScrubberListingReportWriterService() Gets the scrubberListingReportWriterService attribute.
DocumentNumberAwareReportWriterService	getScrubberReportWriterService() Gets the scrubberReportWriterService attribute.
ScrubberValidator	getScrubberValidator() Gets the scrubberValidator attribute.
protected String	getTransactionType(OriginEntryInformation transaction) Determine the type of the transaction by looking at attributes
protected String	getTransactionType(String financialBalanceTypeCode, String desc)
String	getTransferDescription() Gets the transferDescription attribute.
protected void	handleDemergerSaveValidEntry(String entryString)
protected void	handleEndOfScrubberReport(ScrubberReportData scrubberReport)
protected void	handleTransactionError(Transaction errorTransaction, Message message)
protected void	handleTransactionErrors(Transaction errorTransaction, List<Message> messages)
protected boolean	isFatal(List<Message> errors) Determines if a given error is fatal and should stop this scrubber run
void	performDemerger() The demerger process reads all of the documents in the error group, then moves all of the original entries for that document from the valid group to the error group.
protected void	plantFundAccountLookup(OriginEntryInformation scrubbedEntry, OriginEntryFull liabilityEntry) Updates the entries with the proper chart and account for the plant fund
protected void	populateTransactionDebtCreditCode(OriginEntryInformation scrubbedEntry, OriginEntryFull fullEntry) This method...
protected String	processCapitalization(OriginEntryInformation scrubbedEntry, ScrubberReportData scrubberReport) Generates capitalization entries if necessary
protected void	processGroup(boolean reportOnlyMode, ScrubberReportData scrubberReport) This will process a group of origin entries.
protected String	processLiabilities(OriginEntryInformation scrubbedEntry, ScrubberReportData scrubberReport) Generate the liability entries for the entry if necessary
protected String	processPlantIndebtedness(OriginEntryInformation scrubbedEntry, ScrubberReportData scrubberReport) Generates the plant indebtedness entries
protected void	putTransactionError(Transaction s, String errorMessage, String errorValue, int type) Puts a transaction error into this instance's collection of errors
void	scrubCollectorBatch(ScrubberStatus scrubberStatus, CollectorBatch batch, CollectorReportData collectorReportData) Scrubs the origin entry and ID billing details if the given batch.
void	scrubEntries() Scrubs all entries in all groups and documents.
void	scrubEntries(boolean reportOnlyMode, String documentNumber) Scrub all entries that need it in origin entry.
void	scrubGroupReportOnly(String fileName, String documentNumber) Scrub this single group read only.
void	setAccountingCycleCachingService(AccountingCycleCachingService accountingCycleCachingService) Sets the accountingCycleCachingService attribute value.
void	setBatchFileDirectoryName(String batchFileDirectoryName) Sets the batchFileDirectoryName attribute value.
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Sets the businessObjectService attribute value.
void	setConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService configurationService) Sets the configurationService attribute value.
void	setCostShareObjectCode(OriginEntryFull costShareEntry, OriginEntryInformation originEntry) Sets the proper cost share object code in an entry and its offset
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService) Sets the dateTimeService attribute value.
void	setDemergerRemovedTransactionsListingReportWriterService(ReportWriterService demergerRemovedTransactionsListingReportWriterService) Sets the demergerRemovedTransactionsListingReportWriterService attribute value.
void	setDemergerReportWriterService(ReportWriterService demergerReportWriterService) Sets the demergerReportWriterService attribute value.
protected void	setDescriptions() Get all the transaction descriptions from the param table
void	setFlexibleOffsetAccountService(FlexibleOffsetAccountService flexibleOffsetAccountService) Sets the flexibleOffsetAccountService attribute value.
protected void	setOffsetString() Generate the flag for the end of specific descriptions.
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService) Sets the parameterService attribute value.
void	setPersistenceService(org.kuali.rice.krad.service.PersistenceService persistenceService) Sets the persistenceService attribute value.
void	setPreScrubberReportWriterService(DocumentNumberAwareReportWriterService preScrubberReportWriterService) Sets the preScrubberReportWriterService attribute value.
void	setPreScrubberService(PreScrubberService preScrubberService) Sets the preScrubberService attribute value.
void	setRunDateService(RunDateService runDateService) Sets the runDateService attribute value.
void	setScrubberBadBalanceListingReportWriterService(ReportWriterService scrubberBadBalanceListingReportWriterService) Sets the scrubberBadBalanceListingReportWriterService attribute value.
void	setScrubberLedgerReportWriterService(DocumentNumberAwareReportWriterService scrubberLedgerReportWriterService) Sets the scrubberLedgerReportWriterService attribute value.
void	setScrubberListingReportWriterService(DocumentNumberAwareReportWriterService scrubberListingReportWriterService) Sets the scrubberListingReportWriterService attribute value.
void	setScrubberReportWriterService(DocumentNumberAwareReportWriterService scrubberReportWriterService) Sets the scrubberReportWriterService attribute value.
void	setScrubberValidator(ScrubberValidator scrubberValidator) Sets the scrubberValidator attribute value.
void	setTransferDescription(String transferDescription) Sets the transferDescription attribute value.
protected boolean	shouldScrubberGenerateOffsetsForDocType(String docTypeCode) Determines if the scrubber should generate offsets for the given document type

Methods inherited from class java.lang.Object

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

Field Detail

TRANSACTION_TYPE_COST_SHARE_ENCUMBRANCE

protected static final String TRANSACTION_TYPE_COST_SHARE_ENCUMBRANCE

See Also:

Constant Field Values

TRANSACTION_TYPE_OFFSET

protected static final String TRANSACTION_TYPE_OFFSET

See Also:

Constant Field Values

TRANSACTION_TYPE_CAPITALIZATION

protected static final String TRANSACTION_TYPE_CAPITALIZATION

See Also:

Constant Field Values

TRANSACTION_TYPE_LIABILITY

protected static final String TRANSACTION_TYPE_LIABILITY

See Also:

Constant Field Values

TRANSACTION_TYPE_TRANSFER

protected static final String TRANSACTION_TYPE_TRANSFER

See Also:

Constant Field Values

TRANSACTION_TYPE_COST_SHARE

protected static final String TRANSACTION_TYPE_COST_SHARE

See Also:

Constant Field Values

TRANSACTION_TYPE_OTHER

protected static final String TRANSACTION_TYPE_OTHER

See Also:

Constant Field Values

COST_SHARE_CODE

protected static final String COST_SHARE_CODE

See Also:

Constant Field Values

COST_SHARE_TRANSFER_ENTRY_IND

protected static final String COST_SHARE_TRANSFER_ENTRY_IND

See Also:

Constant Field Values

COST_SHARE_ENCUMBRANCE_ENTRY_MAXLENGTH

protected static final int COST_SHARE_ENCUMBRANCE_ENTRY_MAXLENGTH

See Also:

Constant Field Values

DEMERGER_TRANSACTION_LEDGET_ENTRY_DESCRIPTION

protected static final int DEMERGER_TRANSACTION_LEDGET_ENTRY_DESCRIPTION

See Also:

Constant Field Values

OFFSET_MESSAGE_MAXLENGTH

protected static final int OFFSET_MESSAGE_MAXLENGTH

See Also:

Constant Field Values

flexibleOffsetAccountService

protected FlexibleOffsetAccountService flexibleOffsetAccountService

dateTimeService

protected org.kuali.rice.core.api.datetime.DateTimeService dateTimeService

configurationService

protected org.kuali.rice.core.api.config.property.ConfigurationService configurationService

persistenceService

protected org.kuali.rice.krad.service.PersistenceService persistenceService

scrubberValidator

protected ScrubberValidator scrubberValidator

runDateService

protected RunDateService runDateService

accountingCycleCachingService

protected AccountingCycleCachingService accountingCycleCachingService

scrubberReportWriterService

protected DocumentNumberAwareReportWriterService scrubberReportWriterService

scrubberLedgerReportWriterService

protected DocumentNumberAwareReportWriterService scrubberLedgerReportWriterService

scrubberListingReportWriterService

protected DocumentNumberAwareReportWriterService scrubberListingReportWriterService

preScrubberReportWriterService

protected DocumentNumberAwareReportWriterService preScrubberReportWriterService

scrubberBadBalanceListingReportWriterService

protected ReportWriterService scrubberBadBalanceListingReportWriterService

demergerRemovedTransactionsListingReportWriterService

protected ReportWriterService demergerRemovedTransactionsListingReportWriterService

demergerReportWriterService

protected ReportWriterService demergerReportWriterService

preScrubberService

protected PreScrubberService preScrubberService

unscrubbedToScrubbedEntries

protected Map<OriginEntryInformation,OriginEntryInformation> unscrubbedToScrubbedEntries

scrubberReportErrors

protected Map<Transaction,List<Message>> scrubberReportErrors

ledgerSummaryReport

protected LedgerSummaryReport ledgerSummaryReport

scrubberReport

protected ScrubberReportData scrubberReport

demergerReport

protected DemergerReportData demergerReport

runDate

protected Date runDate

runCal

protected Calendar runCal

universityRunDate

protected UniversityDate universityRunDate

offsetString

protected String offsetString

unitOfWork

protected org.kuali.ole.gl.batch.service.impl.ScrubberProcessImpl.UnitOfWorkInfo unitOfWork

scrubCostShareAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal scrubCostShareAmount

transactionErrors

protected List<Message> transactionErrors

offsetDescription

protected String offsetDescription

capitalizationDescription

protected String capitalizationDescription

liabilityDescription

protected String liabilityDescription

transferDescription

protected String transferDescription

costShareDescription

protected String costShareDescription

parameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService

businessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService businessObjectService

collectorMode

protected boolean collectorMode

Whether this instance is being used to support the scrubbing of a collector batch

batchFileDirectoryName

protected String batchFileDirectoryName

OUTPUT_GLE_FILE_ps

protected PrintStream OUTPUT_GLE_FILE_ps

OUTPUT_ERR_FILE_ps

protected PrintStream OUTPUT_ERR_FILE_ps

OUTPUT_EXP_FILE_ps

protected PrintStream OUTPUT_EXP_FILE_ps

inputFile

protected String inputFile

validFile

protected String validFile

errorFile

protected String errorFile

expiredFile

protected String expiredFile

Constructor Detail

ScrubberProcessImpl

public ScrubberProcessImpl()

Method Detail

scrubGroupReportOnly

public void scrubGroupReportOnly(String fileName,
                        String documentNumber)

Scrub this single group read only. This will only output the scrubber report. It won't output any other groups.

Specified by:

scrubGroupReportOnly in interface ScrubberProcess

Parameters:

group - the origin entry group that should be scrubbed

the - document number of any specific entries to scrub

scrubEntries

public void scrubEntries()

Scrubs all entries in all groups and documents.

Specified by:

scrubEntries in interface ScrubberProcess

scrubCollectorBatch

public void scrubCollectorBatch(ScrubberStatus scrubberStatus,
                       CollectorBatch batch,
                       CollectorReportData collectorReportData)

Scrubs the origin entry and ID billing details if the given batch. Store all scrubber output into the collectorReportData parameter. NOTE: DO NOT CALL ANY OF THE scrub* METHODS OF THIS CLASS AFTER CALLING THIS METHOD FOR EVERY UNIQUE INSTANCE OF THIS CLASS, OR THE COLLECTOR REPORTS MAY BE CORRUPTED

Specified by:

scrubCollectorBatch in interface ScrubberProcess

Parameters:

batch - the data gathered from a Collector file

collectorReportData - the statistics generated by running the Collector

scrubEntries

public void scrubEntries(boolean reportOnlyMode,
                String documentNumber)

Scrub all entries that need it in origin entry. Put valid scrubbed entries in a scrubber valid group, put errors in a scrubber error group, and transactions with an expired account in the scrubber expired account group.

Specified by:

scrubEntries in interface ScrubberProcess

Parameters:

group - the specific origin entry group to scrub

documentNumber - the number of the document with entries to scrub

performDemerger

public void performDemerger()

The demerger process reads all of the documents in the error group, then moves all of the original entries for that document from the valid group to the error group. It does not move generated entries to the error group. Those are deleted. It also modifies the doc number and origin code of cost share transfers.

Specified by:

performDemerger in interface ScrubberProcess

Parameters:

errorGroup - this scrubber run's error group

validGroup - this scrubber run's valid group

getTransactionType

protected String getTransactionType(OriginEntryInformation transaction)

Determine the type of the transaction by looking at attributes

Parameters:

transaction - Transaction to identify

Returns:

CE (Cost share encumbrance, O (Offset), C (apitalization), L (Liability), T (Transfer), CS (Cost Share), X (Other)

getTransactionType

protected String getTransactionType(String financialBalanceTypeCode,
                        String desc)

processGroup

protected void processGroup(boolean reportOnlyMode,
                ScrubberReportData scrubberReport)

This will process a group of origin entries. The COBOL code was refactored a lot to get this so there isn't a 1 to 1 section of Cobol relating to this.

Parameters:

originEntryGroup - Group to process

isFatal

protected boolean isFatal(List<Message> errors)

Determines if a given error is fatal and should stop this scrubber run

Parameters:

errors - errors from a scrubber run

Returns:

true if the run should be abended, false otherwise

generateCostShareEntries

protected org.kuali.ole.gl.batch.service.impl.ScrubberProcessImpl.TransactionError generateCostShareEntries(OriginEntryInformation scrubbedEntry,
                                                                                                ScrubberReportData scrubberReport)

Generates a cost share entry and offset for the given entry and saves both to the valid group

Parameters:

scrubbedEntry - the originEntry that was scrubbed

Returns:

a TransactionError initialized with any error encounted during entry generation, or (hopefully) null

setDescriptions

protected void setDescriptions()

Get all the transaction descriptions from the param table

setOffsetString

protected void setOffsetString()

Generate the flag for the end of specific descriptions. This will be used in the demerger step

getOffsetMessage

protected String getOffsetMessage()

Generate the offset message with the flag at the end

Returns:

a generated offset message

processCapitalization

protected String processCapitalization(OriginEntryInformation scrubbedEntry,
                           ScrubberReportData scrubberReport)

Generates capitalization entries if necessary

Parameters:

scrubbedEntry - the entry to generate capitalization entries (possibly) for

Returns:

null if no error, message if error

processPlantIndebtedness

protected String processPlantIndebtedness(OriginEntryInformation scrubbedEntry,
                              ScrubberReportData scrubberReport)

Generates the plant indebtedness entries

Parameters:

scrubbedEntry - the entry to generated plant indebtedness entries for if necessary

Returns:

null if no error, message if error

processLiabilities

protected String processLiabilities(OriginEntryInformation scrubbedEntry,
                        ScrubberReportData scrubberReport)

Generate the liability entries for the entry if necessary

Parameters:

scrubbedEntry - the entry to generate liability entries for if necessary

Returns:

null if no error, message if error

getFundBalanceObjectCode

protected ObjectCode getFundBalanceObjectCode(String fundBalanceCode,
                                  OriginEntryFull originEntryFull)

This method...

Parameters:

fundBalanceCodeParameter -

originEntryFull -

Returns:

populateTransactionDebtCreditCode

protected void populateTransactionDebtCreditCode(OriginEntryInformation scrubbedEntry,
                                     OriginEntryFull fullEntry)

This method...

Parameters:

scrubbedEntry -

fullEntry -

plantFundAccountLookup

protected void plantFundAccountLookup(OriginEntryInformation scrubbedEntry,
                          OriginEntryFull liabilityEntry)

Updates the entries with the proper chart and account for the plant fund

Parameters:

scrubbedEntry - basis for plant fund entry

liabilityEntry - liability entry

generateCostShareEncumbranceEntries

protected org.kuali.ole.gl.batch.service.impl.ScrubberProcessImpl.TransactionError generateCostShareEncumbranceEntries(OriginEntryInformation scrubbedEntry,
                                                                                                           ScrubberReportData scrubberReport)

The purpose of this method is to generate a "Cost Share Encumbrance" transaction for the current transaction and its offset. The cost share chart and account for current transaction are obtained from the CA_A21_SUB_ACCT_T table. This method calls the method SET-OBJECT-2004 to get the Cost Share Object Code. It then writes out the cost share transaction. Next it read the GL_OFFSET_DEFN_T table for the offset object code that corresponds to the cost share object code. In addition to the object code it needs to get subobject code. It then reads the CA_OBJECT_CODE_T table to make sure the offset object code found in the GL_OFFSET_DEFN_T is valid and to get the object type code associated with this object code. It writes out the offset transaction and returns.

Parameters:

scrubbedEntry - the entry to perhaps create a cost share encumbrance for

Returns:

a message if there was an error encountered generating the entries, or (hopefully) null if no errors were encountered

setCostShareObjectCode

public void setCostShareObjectCode(OriginEntryFull costShareEntry,
                          OriginEntryInformation originEntry)

Sets the proper cost share object code in an entry and its offset

Specified by:

setCostShareObjectCode in interface ScrubberProcess

Parameters:

costShareEntry - GL Entry for cost share

originEntry - Scrubbed GL Entry that this is based on

generateOffset

protected boolean generateOffset(OriginEntryInformation scrubbedEntry,
                     ScrubberReportData scrubberReport)

The purpose of this method is to build the actual offset transaction. It does this by performing the following steps: 1. Getting the offset object code and offset subobject code from the GL Offset Definition Table. 2. For the offset object code it needs to get the associated object type, object subtype, and object active code.

Parameters:

scrubbedEntry - entry to determine if an offset is needed for

Returns:

true if an offset would be needed for this entry, false otherwise

createOutputEntry

protected void createOutputEntry(OriginEntryInformation entry,
                     PrintStream ps)
                          throws IOException

Throws:

IOException

createOutputEntry

protected void createOutputEntry(String line,
                     PrintStream ps)
                          throws IOException

Throws:

IOException

addTransactionError

protected void addTransactionError(String errorMessage,
                       String errorValue,
                       int type)

Add an error message to the list of messages for this transaction

Parameters:

errorMessage - Error message

errorValue - Value that is in error

type - Type of error (Fatal or Warning)

putTransactionError

protected void putTransactionError(Transaction s,
                       String errorMessage,
                       String errorValue,
                       int type)

Puts a transaction error into this instance's collection of errors

Parameters:

s - a transaction that caused a scrubber error

errorMessage - the message of what caused the error

errorValue - the value in error

type - the type of error

shouldScrubberGenerateOffsetsForDocType

protected boolean shouldScrubberGenerateOffsetsForDocType(String docTypeCode)

Determines if the scrubber should generate offsets for the given document type

Parameters:

docTypeCode - the document type code to check if it generates scrubber offsets

Returns:

true if the scrubber should generate offsets for this doc type, false otherwise

calculateRunDate

public Date calculateRunDate(Date currentDate)

This method modifies the run date if it is before the cutoff time specified by the RunTimeService See KULRNE-70 This method is public to facilitate unit testing

Specified by:

calculateRunDate in interface ScrubberProcess

Parameters:

currentDate - the date the scrubber should report as having run on

Returns:

the run date

checkingBypassEntry

protected boolean checkingBypassEntry(String financialBalanceTypeCode,
                          String desc,
                          DemergerReportData demergerReport)

checkAndSetTransactionTypeCostShare

protected String checkAndSetTransactionTypeCostShare(String financialBalanceTypeCode,
                                         String desc,
                                         String currentValidLine)

generateScrubberTransactionListingReport

protected void generateScrubberTransactionListingReport(String documentNumber,
                                            String inputFileName)

Generates the scrubber listing report for the GLCP document

Parameters:

documentNumber - the document number of the GLCP document

generateScrubberBlankBalanceTypeCodeReport

protected void generateScrubberBlankBalanceTypeCodeReport(String inputFileName)

Generates the scrubber report that lists out the input origin entries with blank balance type codes.

generateDemergerRemovedTransactionsReport

protected void generateDemergerRemovedTransactionsReport(String errorFileName)

handleTransactionError

protected void handleTransactionError(Transaction errorTransaction,
                          Message message)

handleTransactionErrors

protected void handleTransactionErrors(Transaction errorTransaction,
                           List<Message> messages)

handleEndOfScrubberReport

protected void handleEndOfScrubberReport(ScrubberReportData scrubberReport)

handleDemergerSaveValidEntry

protected void handleDemergerSaveValidEntry(String entryString)

setBatchFileDirectoryName

public void setBatchFileDirectoryName(String batchFileDirectoryName)

Sets the batchFileDirectoryName attribute value.

Parameters:

batchFileDirectoryName - The batchFileDirectoryName to set.

getTransferDescription

public String getTransferDescription()

Gets the transferDescription attribute.

Returns:

Returns the transferDescription.

setTransferDescription

public void setTransferDescription(String transferDescription)

Sets the transferDescription attribute value.

Parameters:

transferDescription - The transferDescription to set.

setDateTimeService

public void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)

Sets the dateTimeService attribute value.

Parameters:

dateTimeService - The dateTimeService to set.

setFlexibleOffsetAccountService

public void setFlexibleOffsetAccountService(FlexibleOffsetAccountService flexibleOffsetAccountService)

Sets the flexibleOffsetAccountService attribute value.

Parameters:

flexibleOffsetAccountService - The flexibleOffsetAccountService to set.

setConfigurationService

public void setConfigurationService(org.kuali.rice.core.api.config.property.ConfigurationService configurationService)

Sets the configurationService attribute value.

Parameters:

configurationService - The configurationService to set.

setPersistenceService

public void setPersistenceService(org.kuali.rice.krad.service.PersistenceService persistenceService)

Sets the persistenceService attribute value.

Parameters:

persistenceService - The persistenceService to set.

setScrubberValidator

public void setScrubberValidator(ScrubberValidator scrubberValidator)

Sets the scrubberValidator attribute value.

Parameters:

scrubberValidator - The scrubberValidator to set.

setAccountingCycleCachingService

public void setAccountingCycleCachingService(AccountingCycleCachingService accountingCycleCachingService)

Sets the accountingCycleCachingService attribute value.

Parameters:

accountingCycleCachingService - The accountingCycleCachingService to set.

setScrubberReportWriterService

public void setScrubberReportWriterService(DocumentNumberAwareReportWriterService scrubberReportWriterService)

Sets the scrubberReportWriterService attribute value.

Parameters:

scrubberReportWriterService - The scrubberReportWriterService to set.

setScrubberLedgerReportWriterService

public void setScrubberLedgerReportWriterService(DocumentNumberAwareReportWriterService scrubberLedgerReportWriterService)

Sets the scrubberLedgerReportWriterService attribute value.

Parameters:

scrubberLedgerReportWriterService - The scrubberLedgerReportWriterService to set.

setScrubberListingReportWriterService

public void setScrubberListingReportWriterService(DocumentNumberAwareReportWriterService scrubberListingReportWriterService)

Sets the scrubberListingReportWriterService attribute value.

Parameters:

scrubberListingReportWriterService - The scrubberListingReportWriterService to set.

setScrubberBadBalanceListingReportWriterService

public void setScrubberBadBalanceListingReportWriterService(ReportWriterService scrubberBadBalanceListingReportWriterService)

Sets the scrubberBadBalanceListingReportWriterService attribute value.

Parameters:

scrubberBadBalanceListingReportWriterService - The scrubberBadBalanceListingReportWriterService to set.

setDemergerRemovedTransactionsListingReportWriterService

public void setDemergerRemovedTransactionsListingReportWriterService(ReportWriterService demergerRemovedTransactionsListingReportWriterService)

Sets the demergerRemovedTransactionsListingReportWriterService attribute value.

Parameters:

demergerRemovedTransactionsListingReportWriterService - The demergerRemovedTransactionsListingReportWriterService to set.

setDemergerReportWriterService

public void setDemergerReportWriterService(ReportWriterService demergerReportWriterService)

Sets the demergerReportWriterService attribute value.

Parameters:

demergerReportWriterService - The demergerReportWriterService to set.

setPreScrubberService

public void setPreScrubberService(PreScrubberService preScrubberService)

Sets the preScrubberService attribute value.

Parameters:

preScrubberService - The preScrubberService to set.

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

Sets the parameterService attribute value.

Parameters:

parameterService - The parameterService to set.

setRunDateService

public void setRunDateService(RunDateService runDateService)

Sets the runDateService attribute value.

Parameters:

runDateService - The runDateService to set.

getFlexibleOffsetAccountService

public FlexibleOffsetAccountService getFlexibleOffsetAccountService()

Gets the flexibleOffsetAccountService attribute.

Returns:

Returns the flexibleOffsetAccountService.

getDateTimeService

public org.kuali.rice.core.api.datetime.DateTimeService getDateTimeService()

Gets the dateTimeService attribute.

Returns:

Returns the dateTimeService.

getConfigurationService

public org.kuali.rice.core.api.config.property.ConfigurationService getConfigurationService()

Gets the configurationService attribute.

Returns:

Returns the configurationService.

getPersistenceService

public org.kuali.rice.krad.service.PersistenceService getPersistenceService()

Gets the persistenceService attribute.

Returns:

Returns the persistenceService.

getScrubberValidator

public ScrubberValidator getScrubberValidator()

Gets the scrubberValidator attribute.

Returns:

Returns the scrubberValidator.

getRunDateService

public RunDateService getRunDateService()

Gets the runDateService attribute.

Returns:

Returns the runDateService.

getAccountingCycleCachingService

public AccountingCycleCachingService getAccountingCycleCachingService()

Gets the accountingCycleCachingService attribute.

Returns:

Returns the accountingCycleCachingService.

getScrubberReportWriterService

public DocumentNumberAwareReportWriterService getScrubberReportWriterService()

Gets the scrubberReportWriterService attribute.

Returns:

Returns the scrubberReportWriterService.

getScrubberLedgerReportWriterService

public DocumentNumberAwareReportWriterService getScrubberLedgerReportWriterService()

Gets the scrubberLedgerReportWriterService attribute.

Returns:

Returns the scrubberLedgerReportWriterService.

getScrubberListingReportWriterService

public DocumentNumberAwareReportWriterService getScrubberListingReportWriterService()

Gets the scrubberListingReportWriterService attribute.

Returns:

Returns the scrubberListingReportWriterService.

getScrubberBadBalanceListingReportWriterService

public ReportWriterService getScrubberBadBalanceListingReportWriterService()

Gets the scrubberBadBalanceListingReportWriterService attribute.

Returns:

Returns the scrubberBadBalanceListingReportWriterService.

getDemergerRemovedTransactionsListingReportWriterService

public ReportWriterService getDemergerRemovedTransactionsListingReportWriterService()

Gets the demergerRemovedTransactionsListingReportWriterService attribute.

Returns:

Returns the demergerRemovedTransactionsListingReportWriterService.

getDemergerReportWriterService

public ReportWriterService getDemergerReportWriterService()

Gets the demergerReportWriterService attribute.

Returns:

Returns the demergerReportWriterService.

getPreScrubberService

public PreScrubberService getPreScrubberService()

Gets the preScrubberService attribute.

Returns:

Returns the preScrubberService.

getParameterService

public org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

Gets the parameterService attribute.

Returns:

Returns the parameterService.

setPreScrubberReportWriterService

public void setPreScrubberReportWriterService(DocumentNumberAwareReportWriterService preScrubberReportWriterService)

Sets the preScrubberReportWriterService attribute value.

Parameters:

preScrubberReportWriterService - The preScrubberReportWriterService to set.

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

Sets the businessObjectService attribute value.

Parameters:

businessObjectService - The businessObjectService to set.