org.kuali.kfs.module.cam.document

Class AssetPaymentDocument

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.kfs.sys.document.FinancialSystemTransactionalDocumentBase

org.kuali.kfs.sys.document.LedgerPostingDocumentBase

org.kuali.kfs.sys.document.GeneralLedgerPostingDocumentBase

org.kuali.kfs.sys.document.AccountingDocumentBase

org.kuali.kfs.module.cam.document.AssetPaymentDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, AccountingDocument, AmountTotaling, 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

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

Capital assets document class for the asset payment document

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allocationFromFPDocuments
protected AssetPaymentAllocationType	assetPaymentAllocationType
protected String	assetPaymentAllocationTypeCode
protected List<AssetPaymentAssetDetail>	assetPaymentAssetDetail
protected boolean	capitalAssetBuilderOriginIndicator
protected Long	capitalAssetNumber
protected static org.apache.log4j.Logger	LOG

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

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

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

generalLedgerPendingEntries

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

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

Fields inherited from class org.kuali.kfs.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
AssetPaymentDocument()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAssetPaymentAssetDetail(AssetPaymentAssetDetail assetPaymentAssetDetail) This method...
List	buildListOfDeletionAwareLists() Remove asset from collection for deletion
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent) Override to call super and then iterate over all GLPEs and update the approved code appropriately.
List	generateSaveEvents() When document save, AddAccountingLineEvent is added by the framework.
AssetPaymentAllocationType	getAssetPaymentAllocationType() Get the asset allocation type
String	getAssetPaymentAllocationTypeCode() Get the allocation code value
List<AssetPaymentAssetDetail>	getAssetPaymentAssetDetail()
AssetDistribution	getAssetPaymentDistributor() Get the asset payment distributor built by AssetPaymentDetails, AssetPaymentAssetDetail and totalHistoricalCost
org.kuali.rice.core.api.util.type.KualiDecimal	getAssetsTotalHistoricalCost() calculates the total previous cost amount of all the assets in the document
protected CapitalAssetManagementModuleService	getCapitalAssetManagementModuleService()
Long	getCapitalAssetNumber()
List<String>	getWorkflowEngineDocumentIdsToLock() Lock on purchase order document since post processor will update PO document by adding notes.
boolean	isAllocationFromFPDocuments() Gets the allocationFromFPDocuments attribute.
boolean	isCapitalAssetBuilderOriginIndicator()
boolean	isDebit(GeneralLedgerPendingEntrySourceDetail postable) Determines if the given AccountingLine (as a GeneralLedgerPostable) is a credit or a debit, in terms of GLPE generation
void	postProcessSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
void	prepareForSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
void	setAllocationFromFPDocuments(boolean allocationFromFPDocuments) Sets the allocationFromFPDocuments attribute.
void	setAssetPaymentAllocationType(AssetPaymentAllocationType assetPaymentAllocationType) Sets the asset allocation type
void	setAssetPaymentAllocationTypeCode(String code) Set the allocation code value
void	setAssetPaymentAssetDetail(List<AssetPaymentAssetDetail> assetPaymentAssetDetail)
void	setCapitalAssetBuilderOriginIndicator(boolean capitalAssetBuilderOriginIndicator)
void	setCapitalAssetNumber(Long capitalAssetNumber)

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

addSourceAccountingLine, addTargetAccountingLine, buildAccountingLineMap, copyAccountingLines, correctSalesTax, customizeExplicitGeneralLedgerPendingEntry, customizeOffsetGeneralLedgerPendingEntry, generateDocumentGeneralLedgerPendingEntries, generateEvents, generateGeneralLedgerPendingEntries, getAccountingLineParser, getDataDictionaryEntry, getDocumentClassForAccountingLineValueAllowedValidation, getEntryValue, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getNextSourceLineNumber, getNextTargetLineNumber, getPersistedSourceAccountingLinesForComparison, getPersistedTargetAccountingLinesForComparison, getSourceAccountingLine, getSourceAccountingLineClass, getSourceAccountingLineEntryName, getSourceAccountingLines, getSourceAccountingLinesForComparison, getSourceAccountingLinesSectionTitle, getSourceTotal, getTargetAccountingLine, getTargetAccountingLineClass, getTargetAccountingLineEntryName, getTargetAccountingLines, getTargetAccountingLinesForComparison, getTargetAccountingLinesSectionTitle, getTargetTotal, getTotalDollarAmount, isDocumentFinalOrProcessed, processExplicitGeneralLedgerPendingEntry, processOffsetGeneralLedgerPendingEntry, setExpiredAccountOverride, setExpiredAccountOverrides, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines, toCopy, toErrorCorrection, updatePostingYearForAccountingLines

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

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

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

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

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

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

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

getAllowsCopy, 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, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, 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.kfs.sys.document.AmountTotaling

getTotalDollarAmount

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

checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, setGeneralLedgerPendingEntries

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

getAccountingPeriod, getPostingPeriodCode, getPostingYear, setAccountingPeriod, setPostingPeriodCode, setPostingYear

Methods inherited from interface org.kuali.kfs.sys.document.FinancialSystemTransactionalDocument

getApplicationDocumentStatus, setApplicationDocumentStatus, updateAndSaveAppDocStatus

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

answerSplitNodeQuestion, getFinancialSystemDocumentHeader

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

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getXmlForRouteReport, populateDocumentForRouting, 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.kfs.sys.document.GeneralLedgerPendingEntrySource

addPendingEntry, clearAnyGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getFinancialSystemDocumentHeader, getPostingYear

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

assetPaymentAssetDetail

protected List<AssetPaymentAssetDetail> assetPaymentAssetDetail

capitalAssetNumber

protected Long capitalAssetNumber

capitalAssetBuilderOriginIndicator

protected boolean capitalAssetBuilderOriginIndicator

assetPaymentAllocationType

protected AssetPaymentAllocationType assetPaymentAllocationType

assetPaymentAllocationTypeCode

protected String assetPaymentAllocationTypeCode

allocationFromFPDocuments

protected boolean allocationFromFPDocuments

Constructor Detail

AssetPaymentDocument

public AssetPaymentDocument()

Method Detail

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Remove asset from collection for deletion

Specified by:

buildListOfDeletionAwareLists in interface org.kuali.rice.krad.bo.PersistableBusinessObject

Overrides:

buildListOfDeletionAwareLists in class AccountingDocumentBase

See Also:

AccountingDocumentBase.buildListOfDeletionAwareLists()

generateSaveEvents

public List generateSaveEvents()

When document save, AddAccountingLineEvent is added by the framework. Also, we need to add AssetPaymentManuallyAddAccountingLineEvent manually to run all relating validations.

Specified by:

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

Overrides:

generateSaveEvents in class AccountingDocumentBase

See Also:

AccountingDocumentBase.generateSaveEvents()

getWorkflowEngineDocumentIdsToLock

public List<String> getWorkflowEngineDocumentIdsToLock()

Lock on purchase order document since post processor will update PO document by adding notes.

Specified by:

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

Overrides:

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

See Also:

DocumentBase.getWorkflowEngineDocumentIdsToLock()

isDebit

public boolean isDebit(GeneralLedgerPendingEntrySourceDetail postable)

Determines if the given AccountingLine (as a GeneralLedgerPostable) is a credit or a debit, in terms of GLPE generation

Specified by:

isDebit in interface GeneralLedgerPendingEntrySource

Specified by:

isDebit in class AccountingDocumentBase

Returns:

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

See Also:

org.kuali.kfs.sys.document.AccountingDocumentBase#isDebit(org.kuali.kfs.bo.GeneralLedgerPostable)

isCapitalAssetBuilderOriginIndicator

public boolean isCapitalAssetBuilderOriginIndicator()

setCapitalAssetBuilderOriginIndicator

public void setCapitalAssetBuilderOriginIndicator(boolean capitalAssetBuilderOriginIndicator)

addAssetPaymentAssetDetail

public void addAssetPaymentAssetDetail(AssetPaymentAssetDetail assetPaymentAssetDetail)

This method...

Parameters:

assetPaymentAssetDetail -

postProcessSave

public void postProcessSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)

Specified by:

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

Overrides:

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

See Also:

org.kuali.rice.krad.document.DocumentBase#postProcessSave(org.kuali.rice.krad.rule.event.KualiDocumentEvent)

getCapitalAssetManagementModuleService

protected CapitalAssetManagementModuleService getCapitalAssetManagementModuleService()

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)

Description copied from class: GeneralLedgerPostingDocumentBase

Override to call super and then iterate over all GLPEs and update the approved code appropriately.

Specified by:

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

Overrides:

doRouteStatusChange in class GeneralLedgerPostingDocumentBase

See Also:

org.kuali.kfs.sys.document.GeneralLedgerPostingDocumentBase#doRouteStatusChange()

prepareForSave

public void prepareForSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)

Specified by:

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

Overrides:

prepareForSave in class AccountingDocumentBase

See Also:

org.kuali.kfs.sys.document.AccountingDocumentBase#prepareForSave(org.kuali.rice.krad.rule.event.KualiDocumentEvent)

getAssetPaymentAssetDetail

public List<AssetPaymentAssetDetail> getAssetPaymentAssetDetail()

setAssetPaymentAssetDetail

public void setAssetPaymentAssetDetail(List<AssetPaymentAssetDetail> assetPaymentAssetDetail)

getCapitalAssetNumber

public Long getCapitalAssetNumber()

setCapitalAssetNumber

public void setCapitalAssetNumber(Long capitalAssetNumber)

getAssetsTotalHistoricalCost

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

calculates the total previous cost amount of all the assets in the document

Returns:

KualiDecimal

getAssetPaymentDistributor

public AssetDistribution getAssetPaymentDistributor()

Get the asset payment distributor built by AssetPaymentDetails, AssetPaymentAssetDetail and totalHistoricalCost

Returns:

AssetPaymentDistributor

getAssetPaymentAllocationTypeCode

public String getAssetPaymentAllocationTypeCode()

Get the allocation code value

setAssetPaymentAllocationTypeCode

public void setAssetPaymentAllocationTypeCode(String code)

Set the allocation code value

setAssetPaymentAllocationType

public void setAssetPaymentAllocationType(AssetPaymentAllocationType assetPaymentAllocationType)

Sets the asset allocation type

getAssetPaymentAllocationType

public AssetPaymentAllocationType getAssetPaymentAllocationType()

Get the asset allocation type

isAllocationFromFPDocuments

public boolean isAllocationFromFPDocuments()

Gets the allocationFromFPDocuments attribute.

Returns:

Returns the allocationFromFPDocuments

setAllocationFromFPDocuments

public void setAllocationFromFPDocuments(boolean allocationFromFPDocuments)

Sets the allocationFromFPDocuments attribute.

Parameters:

allocationFromFPDocuments - The allocationFromFPDocuments to set.