org.kuali.ole.fp.document

Class BudgetAdjustmentDocument

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.rice.krad.document.DocumentBase

org.kuali.rice.krad.document.TransactionalDocumentBase

org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

org.kuali.ole.sys.document.LedgerPostingDocumentBase

org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

org.kuali.ole.sys.document.AccountingDocumentBase

org.kuali.ole.fp.document.BudgetAdjustmentDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, AccountingDocument, AmountTotaling, Correctable, FinancialSystemDocument, FinancialSystemTransactionalDocument, GeneralLedgerPendingEntrySource, GeneralLedgerPostingDocument, LedgerPostingDocument, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject, org.kuali.rice.krad.document.Copyable, org.kuali.rice.krad.document.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

Direct Known Subclasses:

YearEndBudgetAdjustmentDocument

public class BudgetAdjustmentDocument
extends AccountingDocumentBase
implements org.kuali.rice.krad.document.Copyable, Correctable, AmountTotaling

This is the business object that represents the BudgetAdjustment document in Kuali.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	LOG
protected Integer	nextPositionSourceLineNumber
protected Integer	nextPositionTargetLineNumber
protected static String	REQUIRES_FULL_APPROVAL_SPLIT_NODE_NAME

Fields inherited from class org.kuali.ole.sys.document.AccountingDocumentBase

dataDictionaryEntry, nextSourceLineNumber, nextTargetLineNumber, sourceAccountingLineClass, sourceAccountingLines, targetAccountingLineClass, targetAccountingLines

Fields inherited from class org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

generalLedgerPendingEntries

Fields inherited from class org.kuali.ole.sys.document.LedgerPostingDocumentBase

accountingPeriod, accountingPeriodService, checkPostingYearForCopy, dataDictionaryService, dateTimeService, postingPeriodCode, postingYear

Fields inherited from class org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

UPDATE_TOTAL_AMOUNT_IN_POST_PROCESSING_PARAMETER_NAME

Fields inherited from class org.kuali.rice.krad.document.DocumentBase

documentHeader, documentNumber

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
BudgetAdjustmentDocument() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	answerSplitNodeQuestion(String nodeName)
Map	buildIncomeStreamBalanceMapForDocumentBalance() Builds a map used for balancing current adjustment amounts.
Map	buildIncomeStreamBalanceMapForTransferOfFundsGeneration() Builds a map used for balancing current adjustment amounts.
protected void	createMonthlyBudgetGLPE(AccountingLine accountingLine, GeneralLedgerPendingEntrySequenceHelper sequenceHelper, String fiscalPeriod, org.kuali.rice.core.api.util.type.KualiDecimal monthAmount) Helper method for creating monthly budget pending entry lines.
boolean	generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper) Generates any necessary tof entries to transfer funds needed to make the budget adjustments.
boolean	generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail, GeneralLedgerPendingEntrySequenceHelper sequenceHelper) The budget adjustment document creates GL pending entries much differently that common tp-edocs.
boolean	getAllowsCopy() The base checks that the posting year is the current year, not a requirement for the ba document.
String	getCurrencyFormattedSourceBaseBudgetTotal() This method retrieves the total base budget amount formatted as currency.
String	getCurrencyFormattedSourceCurrentBudgetTotal() This method retrieves the total current budget amount formatted as currency.
String	getCurrencyFormattedTargetBaseBudgetTotal() This method retrieves the total base budget amount formatted as currency.
String	getCurrencyFormattedTargetCurrentBudgetTotal() This method retrieves the total current budget amount formatted as currency.
GeneralLedgerPendingEntryService	getGeneralLedgerPendingEntryService() Returns an implementation of the GeneralLedgerPendingEntryService
protected org.kuali.rice.core.api.util.type.KualiDecimal	getIncomeStreamAmount(BudgetAdjustmentAccountingLine budgetAccountingLine, org.kuali.rice.core.api.util.type.KualiDecimal incomeStreamAmount) This method calculates the appropriate income stream amount for an account using the value provided and the provided accounting line.
Integer	getNextPositionSourceLineNumber()
Integer	getNextPositionTargetLineNumber()
List<GeneralLedgerPendingEntry>	getPendingLedgerEntriesForSufficientFundsChecking() BA Documents should only do SF checking on PLEs with a Balance Type of 'CB' - not 'BB' or 'MB'.
String	getSourceAccountingLinesSectionTitle() This method is used to return the title that a transactional document should give to it's source accounting line section.
org.kuali.rice.core.api.util.type.KualiDecimal	getSourceBaseBudgetExpenseTotal() Returns the total base budget expense amount from the source lines.
org.kuali.rice.core.api.util.type.KualiDecimal	getSourceBaseBudgetIncomeTotal() Returns the total base budget income amount from the source lines.
org.kuali.rice.core.api.util.type.KualiDecimal	getSourceBaseBudgetTotal() Returns the total base budget amount from the source lines.
org.kuali.rice.core.api.util.type.KualiDecimal	getSourceCurrentBudgetExpenseTotal() Returns the total current budget expense amount from the source lines.
org.kuali.rice.core.api.util.type.KualiDecimal	getSourceCurrentBudgetIncomeTotal() Returns the total current budget income amount from the source lines.
org.kuali.rice.core.api.util.type.KualiDecimal	getSourceCurrentBudgetTotal() Returns the total current budget amount from the source lines.
String	getTargetAccountingLinesSectionTitle() This method is used to return the title that a transactional document should give to it's source accounting line section.
org.kuali.rice.core.api.util.type.KualiDecimal	getTargetBaseBudgetExpenseTotal() Returns the total base budget expense amount from the target lines.
org.kuali.rice.core.api.util.type.KualiDecimal	getTargetBaseBudgetIncomeTotal() Returns the total base budget income amount from the target lines.
org.kuali.rice.core.api.util.type.KualiDecimal	getTargetBaseBudgetTotal() Returns the total base budget amount from the target lines.
org.kuali.rice.core.api.util.type.KualiDecimal	getTargetCurrentBudgetExpenseTotal() Returns the total current budget expense amount from the target lines.
org.kuali.rice.core.api.util.type.KualiDecimal	getTargetCurrentBudgetIncomeTotal() Returns the total current budget income amount from the target lines.
org.kuali.rice.core.api.util.type.KualiDecimal	getTargetCurrentBudgetTotal() Returns the total current budget amount from the target lines.
org.kuali.rice.core.api.util.type.KualiDecimal	getTotalDollarAmount() Same as default implementation but uses getTargetCurrentBudgetTotal and getSourceCurrentBudgetTotal instead.
protected String	getTransferDocumentType() Returns the document type code for the Transfer of Funds document
void	initiateDocument() generic, shared logic used to iniate a ba document
boolean	isDebit(GeneralLedgerPendingEntrySourceDetail postable) Returns true if accounting line is debit
void	populateDocumentForRouting()
protected boolean	requiresFullApproval() Determines if this document can be auto-approved or not.
void	setNextPositionSourceLineNumber(Integer nextPositionSourceLineNumber)
void	setNextPositionTargetLineNumber(Integer nextPositionTargetLineNumber)
void	toErrorCorrection() Negate accounting line budget amounts.

Methods inherited from class org.kuali.ole.sys.document.AccountingDocumentBase

addSourceAccountingLine, addTargetAccountingLine, buildAccountingLineMap, buildListOfDeletionAwareLists, copyAccountingLines, customizeExplicitGeneralLedgerPendingEntry, customizeOffsetGeneralLedgerPendingEntry, generateEvents, generateSaveEvents, getAccountingLineParser, getDataDictionaryEntry, getDocumentClassForAccountingLineValueAllowedValidation, getEntryValue, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getNextSourceLineNumber, getNextTargetLineNumber, getPersistedSourceAccountingLinesForComparison, getPersistedTargetAccountingLinesForComparison, getSourceAccountingLine, getSourceAccountingLineClass, getSourceAccountingLineEntryName, getSourceAccountingLines, getSourceAccountingLinesForComparison, getSourceTotal, getTargetAccountingLine, getTargetAccountingLineClass, getTargetAccountingLineEntryName, getTargetAccountingLines, getTargetAccountingLinesForComparison, getTargetTotal, isDocumentFinalOrProcessed, prepareForSave, processExplicitGeneralLedgerPendingEntry, processOffsetGeneralLedgerPendingEntry, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines, toCopy, updatePostingYearForAccountingLines

Methods inherited from class org.kuali.ole.sys.document.GeneralLedgerPostingDocumentBase

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, checkSufficientFunds, clearAnyGeneralLedgerPendingEntries, documentPerformsSufficientFundsCheck, doRouteStatusChange, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, removeGeneralLedgerPendingEntries, setGeneralLedgerPendingEntries

Methods inherited from class org.kuali.ole.sys.document.LedgerPostingDocumentBase

createInitialAccountingPeriod, getAccountingPeriod, getAccountingPeriodCompositeString, getAccountingPeriodService, getDataDictionaryService, getDateTimeService, getFinancialDocumentTypeCode, getPostingPeriodCode, getPostingYear, retrieveCurrentAccountingPeriod, setAccountingPeriod, setAccountingPeriodCompositeString, setPostingPeriodCode, setPostingYear

Methods inherited from class org.kuali.ole.sys.document.FinancialSystemTransactionalDocumentBase

doRouteLevelChange, getApplicationDocumentStatus, getBusinessObjectService, getFinancialSystemDocumentHeader, getFinancialSystemDocumentService, getParameterService, prepareForSave, processAfterRetrieve, setApplicationDocumentStatus, setDocumentHeader, updateAndSaveAppDocStatus

Methods inherited from class org.kuali.rice.krad.document.TransactionalDocumentBase

isSessionDocument

Methods inherited from class org.kuali.rice.krad.document.DocumentBase

addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, postLoad, postProcessSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.document.Copyable

toCopy

Methods inherited from interface org.kuali.ole.sys.document.GeneralLedgerPostingDocument

checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, setGeneralLedgerPendingEntries

Methods inherited from interface org.kuali.ole.sys.document.LedgerPostingDocument

getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode, setPostingYear

Methods inherited from interface org.kuali.ole.sys.document.FinancialSystemDocument

getFinancialSystemDocumentHeader

Methods inherited from interface org.kuali.rice.krad.document.Document

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, doRouteStatusChange, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, postProcessSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

Methods inherited from interface org.kuali.rice.krad.bo.PersistableBusinessObject

getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Methods inherited from interface org.kuali.ole.sys.document.GeneralLedgerPendingEntrySource

addPendingEntry, clearAnyGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getFinancialSystemDocumentHeader, getPostingYear

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

REQUIRES_FULL_APPROVAL_SPLIT_NODE_NAME

protected static final String REQUIRES_FULL_APPROVAL_SPLIT_NODE_NAME

See Also:

Constant Field Values

nextPositionSourceLineNumber

protected Integer nextPositionSourceLineNumber

nextPositionTargetLineNumber

protected Integer nextPositionTargetLineNumber

Constructor Detail

BudgetAdjustmentDocument

public BudgetAdjustmentDocument()

Default constructor.

Method Detail

getPendingLedgerEntriesForSufficientFundsChecking

public List<GeneralLedgerPendingEntry> getPendingLedgerEntriesForSufficientFundsChecking()

BA Documents should only do SF checking on PLEs with a Balance Type of 'CB' - not 'BB' or 'MB'.

Specified by:

getPendingLedgerEntriesForSufficientFundsChecking in interface GeneralLedgerPostingDocument

Overrides:

getPendingLedgerEntriesForSufficientFundsChecking in class GeneralLedgerPostingDocumentBase

Returns:

a list of sufficientfundsitems that do not have sufficient funds. It returns an empty list if there is sufficient funds for the entire document

See Also:

GeneralLedgerPostingDocumentBase.getPendingLedgerEntriesForSufficientFundsChecking()

initiateDocument

public void initiateDocument()

generic, shared logic used to iniate a ba document

getNextPositionSourceLineNumber

public Integer getNextPositionSourceLineNumber()

Returns:

Integer

setNextPositionSourceLineNumber

public void setNextPositionSourceLineNumber(Integer nextPositionSourceLineNumber)

Parameters:

nextPositionSourceLineNumber -

getNextPositionTargetLineNumber

public Integer getNextPositionTargetLineNumber()

Returns:

Integer

setNextPositionTargetLineNumber

public void setNextPositionTargetLineNumber(Integer nextPositionTargetLineNumber)

Parameters:

nextPositionTargetLineNumber -

getSourceCurrentBudgetTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getSourceCurrentBudgetTotal()

Returns the total current budget amount from the source lines.

Returns:

KualiDecimal

getCurrencyFormattedSourceCurrentBudgetTotal

public String getCurrencyFormattedSourceCurrentBudgetTotal()

This method retrieves the total current budget amount formatted as currency.

Returns:

String

getSourceCurrentBudgetIncomeTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getSourceCurrentBudgetIncomeTotal()

Returns the total current budget income amount from the source lines.

Returns:

KualiDecimal

getSourceCurrentBudgetExpenseTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getSourceCurrentBudgetExpenseTotal()

Returns the total current budget expense amount from the source lines.

Returns:

KualiDecimal

getTargetCurrentBudgetTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getTargetCurrentBudgetTotal()

Returns the total current budget amount from the target lines.

Returns:

KualiDecimal

getCurrencyFormattedTargetCurrentBudgetTotal

public String getCurrencyFormattedTargetCurrentBudgetTotal()

This method retrieves the total current budget amount formatted as currency.

Returns:

String

getTargetCurrentBudgetIncomeTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getTargetCurrentBudgetIncomeTotal()

Returns the total current budget income amount from the target lines.

Returns:

KualiDecimal

getTargetCurrentBudgetExpenseTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getTargetCurrentBudgetExpenseTotal()

Returns the total current budget expense amount from the target lines.

Returns:

KualiDecimal

getSourceBaseBudgetTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getSourceBaseBudgetTotal()

Returns the total base budget amount from the source lines.

Returns:

KualiDecimal

getCurrencyFormattedSourceBaseBudgetTotal

public String getCurrencyFormattedSourceBaseBudgetTotal()

This method retrieves the total base budget amount formatted as currency.

Returns:

String

getSourceBaseBudgetIncomeTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getSourceBaseBudgetIncomeTotal()

Returns the total base budget income amount from the source lines.

Returns:

KualiDecimal

getSourceBaseBudgetExpenseTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getSourceBaseBudgetExpenseTotal()

Returns the total base budget expense amount from the source lines.

Returns:

KualiDecimal

getTargetBaseBudgetTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getTargetBaseBudgetTotal()

Returns the total base budget amount from the target lines.

Returns:

KualiDecimal

getCurrencyFormattedTargetBaseBudgetTotal

public String getCurrencyFormattedTargetBaseBudgetTotal()

This method retrieves the total base budget amount formatted as currency.

Returns:

String

getTargetBaseBudgetIncomeTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getTargetBaseBudgetIncomeTotal()

Returns the total base budget income amount from the target lines.

Returns:

KualiDecimal

getTargetBaseBudgetExpenseTotal

public org.kuali.rice.core.api.util.type.KualiDecimal getTargetBaseBudgetExpenseTotal()

Returns the total base budget expense amount from the target lines.

Returns:

KualiDecimal

getTotalDollarAmount

public org.kuali.rice.core.api.util.type.KualiDecimal getTotalDollarAmount()

Same as default implementation but uses getTargetCurrentBudgetTotal and getSourceCurrentBudgetTotal instead.

Specified by:

getTotalDollarAmount in interface AmountTotaling

Overrides:

getTotalDollarAmount in class AccountingDocumentBase

Returns:

KualiDecimal

See Also:

AccountingDocumentBase.getTotalDollarAmount()

toErrorCorrection

public void toErrorCorrection()
                       throws org.kuali.rice.kew.api.exception.WorkflowException

Negate accounting line budget amounts.

Specified by:

toErrorCorrection in interface Correctable

Overrides:

toErrorCorrection in class AccountingDocumentBase

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

See Also:

AccountingDocumentBase.toErrorCorrection()

getAllowsCopy

public boolean getAllowsCopy()

The base checks that the posting year is the current year, not a requirement for the ba document.

Specified by:

getAllowsCopy in interface org.kuali.rice.krad.document.Document

Overrides:

getAllowsCopy in class org.kuali.rice.krad.document.TransactionalDocumentBase

See Also:

TransactionalDocumentBase.getAllowsCopy()

getSourceAccountingLinesSectionTitle

public String getSourceAccountingLinesSectionTitle()

Description copied from interface: AccountingDocument

This method is used to return the title that a transactional document should give to it's source accounting line section.

Specified by:

getSourceAccountingLinesSectionTitle in interface AccountingDocument

Overrides:

getSourceAccountingLinesSectionTitle in class AccountingDocumentBase

Returns:

The source accounting line section's title.

See Also:

AccountingDocumentBase.getSourceAccountingLinesSectionTitle()

getTargetAccountingLinesSectionTitle

public String getTargetAccountingLinesSectionTitle()

Description copied from interface: AccountingDocument

This method is used to return the title that a transactional document should give to it's source accounting line section.

Specified by:

getTargetAccountingLinesSectionTitle in interface AccountingDocument

Overrides:

getTargetAccountingLinesSectionTitle in class AccountingDocumentBase

Returns:

The target accounting line section's title.

See Also:

AccountingDocumentBase.getTargetAccountingLinesSectionTitle()

populateDocumentForRouting

public void populateDocumentForRouting()

Specified by:

populateDocumentForRouting in interface org.kuali.rice.krad.document.Document

Overrides:

populateDocumentForRouting in class org.kuali.rice.krad.document.DocumentBase

See Also:

DocumentBase.populateDocumentForRouting()

isDebit

public boolean isDebit(GeneralLedgerPendingEntrySourceDetail postable)

Returns true if accounting line is debit

Specified by:

isDebit in interface GeneralLedgerPendingEntrySource

Specified by:

isDebit in class AccountingDocumentBase

Parameters:

financialDocument - submitted financial document

accountingLine - accounting line being evaluated as a debit or not

Returns:

true if the given GeneralLedgerPendingEntrySourceDetail is a debit, false if it is a credit

See Also:

org.kuali.rice.krad.rule.AccountingLineRule#isDebit(org.kuali.rice.krad.document.FinancialDocument, org.kuali.rice.krad.bo.AccountingLine)

generateGeneralLedgerPendingEntries

public boolean generateGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySourceDetail glpeSourceDetail,
                                          GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

The budget adjustment document creates GL pending entries much differently that common tp-edocs. The glpes are created for BB, CB, and MB balance types. Up to 14 entries per line can be created. Along with this, the BA will create TOF entries if needed to move funding.

Specified by:

generateGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySource

Overrides:

generateGeneralLedgerPendingEntries in class AccountingDocumentBase

Parameters:

financialDocument - submitted accounting document

accountingLine - validated accounting line

sequenceHelper - helper class for keeping track of sequence number

Returns:

true if GLPE entries are successfully created.

See Also:

org.kuali.module.financial.rules.FinancialDocumentRuleBase#processGenerateGeneralLedgerPendingEntries(org.kuali.rice.krad.document.FinancialDocument, org.kuali.rice.krad.bo.AccountingLine, org.kuali.ole.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)

createMonthlyBudgetGLPE

protected void createMonthlyBudgetGLPE(AccountingLine accountingLine,
                           GeneralLedgerPendingEntrySequenceHelper sequenceHelper,
                           String fiscalPeriod,
                           org.kuali.rice.core.api.util.type.KualiDecimal monthAmount)

Helper method for creating monthly budget pending entry lines.

Parameters:

financialDocument - submitted accounting document

accountingLine - validated accounting line

sequenceHelper - helper class for keeping track of sequence number

fiscalPeriod - fiscal year period code

monthAmount - ledger entry amount for the month

getGeneralLedgerPendingEntryService

public GeneralLedgerPendingEntryService getGeneralLedgerPendingEntryService()

Returns an implementation of the GeneralLedgerPendingEntryService

Returns:

an implementation of the GeneralLedgerPendingEntryService

generateDocumentGeneralLedgerPendingEntries

public boolean generateDocumentGeneralLedgerPendingEntries(GeneralLedgerPendingEntrySequenceHelper sequenceHelper)

Generates any necessary tof entries to transfer funds needed to make the budget adjustments. Based on income chart and accounts. If there is a difference in funds between an income chart and account, a tof entry needs to be created, along with a budget adjustment entry. Object code used is retrieved by a parameter.

Specified by:

generateDocumentGeneralLedgerPendingEntries in interface GeneralLedgerPendingEntrySource

Overrides:

generateDocumentGeneralLedgerPendingEntries in class AccountingDocumentBase

Parameters:

sequenceHelper - helper class for keeping track of sequence number

Returns:

true general ledger pending entries are generated without any problems

See Also:

org.kuali.rice.krad.rule.GenerateGeneralLedgerDocumentPendingEntriesRule#processGenerateDocumentGeneralLedgerPendingEntries(org.kuali.rice.krad.document.FinancialDocument, org.kuali.ole.sys.businessobject.GeneralLedgerPendingEntrySequenceHelper)

buildIncomeStreamBalanceMapForTransferOfFundsGeneration

public Map buildIncomeStreamBalanceMapForTransferOfFundsGeneration()

Builds a map used for balancing current adjustment amounts. The map contains income chart and accounts contained on the document as the keys, and transfer amounts as the values. The transfer amount is calculated from (curr_frm_inc - curr_frm_exp) - (curr_to_inc - curr_to_exp)

Parameters:

baDocument - budget adjustment document

Returns:

Map used to balance current amounts

buildIncomeStreamBalanceMapForDocumentBalance

public Map buildIncomeStreamBalanceMapForDocumentBalance()

Builds a map used for balancing current adjustment amounts. The map contains income chart and accounts contained on the document as the keys, and transfer amounts as the values. The transfer amount is calculated from (curr_frm_inc - curr_frm_exp) - (curr_to_inc - curr_to_exp)

Parameters:

baDocument - budget adjustment document

Returns:

Map used to balance current amounts

getIncomeStreamAmount

protected org.kuali.rice.core.api.util.type.KualiDecimal getIncomeStreamAmount(BudgetAdjustmentAccountingLine budgetAccountingLine,
                                                                   org.kuali.rice.core.api.util.type.KualiDecimal incomeStreamAmount)

This method calculates the appropriate income stream amount for an account using the value provided and the provided accounting line.

Parameters:

budgetAccountingLine -

incomeStreamAmount -

Returns:

getTransferDocumentType

protected String getTransferDocumentType()

Returns the document type code for the Transfer of Funds document

Returns:

the document type name to be used for the income stream transfer glpe

answerSplitNodeQuestion

public boolean answerSplitNodeQuestion(String nodeName)
                                throws UnsupportedOperationException

Specified by:

answerSplitNodeQuestion in interface FinancialSystemDocument

Overrides:

answerSplitNodeQuestion in class FinancialSystemTransactionalDocumentBase

Throws:

UnsupportedOperationException

See Also:

FinancialSystemTransactionalDocumentBase.answerSplitNodeQuestion(java.lang.String)

requiresFullApproval

protected boolean requiresFullApproval()

Determines if this document can be auto-approved or not. The conditions for auto-approval are: 1) Single account used on document 2) Initiator is fiscal officer or primary delegate for the account 3) Only current adjustments are being made 4) The fund group for the account is not contract and grants 5) current income/expense decrease amount must equal increase amount

Returns:

false if auto-approval can occur (and therefore, full approval is not required); true if a full approval is required