org.kuali.ole.fp.document

Class ProcurementCardDocument

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.CapitalAssetInformationDocumentBase

org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase

org.kuali.ole.fp.document.ProcurementCardDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, CapitalAssetEditable, 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.Document, org.kuali.rice.krad.document.SessionDocument, org.kuali.rice.krad.document.TransactionalDocument

public class ProcurementCardDocument
extends CapitalAccountingLinesDocumentBase
implements AmountTotaling, CapitalAssetEditable

This is the Procurement Card Document Class. The procurement cards distributes expenses from clearing accounts. It is a two-sided document, but only target lines are displayed because source lines cannot be changed. Transaction, Card, and Vendor information are associated with the document to help better distribute the expense.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected CapitalAssetManagementModuleService	capitalAssetManagementModuleService
protected static org.apache.log4j.Logger	LOG
protected ProcurementCardTargetAccountingLine	newTargetLine
protected ProcurementCardHolder	procurementCardHolder
protected List	transactionEntries

Fields inherited from class org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase

capitalAccountingLines

Fields inherited from class org.kuali.ole.fp.document.CapitalAssetInformationDocumentBase

capitalAssetInformation, nextCapitalAssetLineNumber

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
ProcurementCardDocument() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSourceAccountingLine(SourceAccountingLine sourceLine) Override to set the accounting line in the transaction detail object.
void	addTargetAccountingLine(TargetAccountingLine targetLine) Override to set the accounting line in the transaction detail object.
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.
protected CapitalAssetManagementModuleService	getCapitalAssetManagementModuleService()
ProcurementCardHolder	getProcurementCardHolder() Gets the procurementCardHolder attribute.
Class	getSourceAccountingLineClass() Returns the default Source accounting line class.
List	getSourceAccountingLines() Override to get source accounting lines out of transactions
Class	getTargetAccountingLineClass() Returns the default Target accounting line class.
List	getTargetAccountingLines() Override to get target accounting lines out of transactions
List	getTransactionEntries()
boolean	isDebit(GeneralLedgerPendingEntrySourceDetail postable) On procurement card documents, positive source amounts are credits, negative source amounts are debits.
void	postProcessSave(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
void	removeTargetAccountingLine(int index) Removes the target accounting line at the given index from the transaction detail entry.
void	setProcurementCardHolder(ProcurementCardHolder procurementCardHolder) Sets the procurementCardHolder attribute value.
void	setTransactionEntries(List transactionEntries)

Methods inherited from class org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase

getCapitalAccountingLines, setCapitalAccountingLines

Methods inherited from class org.kuali.ole.fp.document.CapitalAssetInformationDocumentBase

buildListOfDeletionAwareLists, getCapitalAssetInformation, getNextCapitalAssetLineNumber, setCapitalAssetInformation, setNextCapitalAssetLineNumber

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

buildAccountingLineMap, copyAccountingLines, customizeExplicitGeneralLedgerPendingEntry, customizeOffsetGeneralLedgerPendingEntry, generateDocumentGeneralLedgerPendingEntries, generateEvents, generateGeneralLedgerPendingEntries, generateSaveEvents, getAccountingLineParser, getDataDictionaryEntry, getDocumentClassForAccountingLineValueAllowedValidation, getEntryValue, getGeneralLedgerPendingEntryAmountForDetail, getGeneralLedgerPendingEntrySourceDetails, getNextSourceLineNumber, getNextTargetLineNumber, getPersistedSourceAccountingLinesForComparison, getPersistedTargetAccountingLinesForComparison, getSourceAccountingLine, getSourceAccountingLineEntryName, getSourceAccountingLinesForComparison, getSourceAccountingLinesSectionTitle, getSourceTotal, getTargetAccountingLine, getTargetAccountingLineEntryName, getTargetAccountingLinesForComparison, getTargetAccountingLinesSectionTitle, getTargetTotal, getTotalDollarAmount, isDocumentFinalOrProcessed, prepareForSave, processExplicitGeneralLedgerPendingEntry, processOffsetGeneralLedgerPendingEntry, setNextSourceLineNumber, setNextTargetLineNumber, setSourceAccountingLines, setTargetAccountingLines, toCopy, toErrorCorrection, updatePostingYearForAccountingLines

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

addPendingEntry, changeGeneralLedgerPendingEntriesApprovedStatusCode, checkSufficientFunds, clearAnyGeneralLedgerPendingEntries, documentPerformsSufficientFundsCheck, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, 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

answerSplitNodeQuestion, doRouteLevelChange, getApplicationDocumentStatus, getBusinessObjectService, getFinancialSystemDocumentHeader, getFinancialSystemDocumentService, getParameterService, 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, getWorkflowEngineDocumentIdsToLock, 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.ole.sys.document.AmountTotaling

getTotalDollarAmount

Methods inherited from interface org.kuali.ole.fp.document.CapitalAssetEditable

getCapitalAssetInformation, setCapitalAssetInformation

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

checkSufficientFunds, getGeneralLedgerPendingEntries, getGeneralLedgerPendingEntry, getPendingLedgerEntriesForSufficientFundsChecking, 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

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, getWorkflowEngineDocumentIdsToLock, 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.ole.sys.document.GeneralLedgerPendingEntrySource

addPendingEntry, clearAnyGeneralLedgerPendingEntries, getDocumentHeader, getFinancialDocumentTypeCode, getFinancialSystemDocumentHeader, getPostingYear

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

procurementCardHolder

protected ProcurementCardHolder procurementCardHolder

transactionEntries

protected List transactionEntries

newTargetLine

protected ProcurementCardTargetAccountingLine newTargetLine

capitalAssetManagementModuleService

protected transient CapitalAssetManagementModuleService capitalAssetManagementModuleService

Constructor Detail

ProcurementCardDocument

public ProcurementCardDocument()

Default constructor.

Method Detail

getTransactionEntries

public List getTransactionEntries()

Returns:

Returns the transactionEntries.

setTransactionEntries

public void setTransactionEntries(List transactionEntries)

Parameters:

transactionEntries - The transactionEntries to set.

getProcurementCardHolder

public ProcurementCardHolder getProcurementCardHolder()

Gets the procurementCardHolder attribute.

Returns:

Returns the procurementCardHolder.

setProcurementCardHolder

public void setProcurementCardHolder(ProcurementCardHolder procurementCardHolder)

Sets the procurementCardHolder attribute value.

Parameters:

procurementCardHolder - The procurementCardHolder to set.

removeTargetAccountingLine

public void removeTargetAccountingLine(int index)

Removes the target accounting line at the given index from the transaction detail entry.

Parameters:

index -

addSourceAccountingLine

public void addSourceAccountingLine(SourceAccountingLine sourceLine)

Override to set the accounting line in the transaction detail object.

Specified by:

addSourceAccountingLine in interface AccountingDocument

Overrides:

addSourceAccountingLine in class AccountingDocumentBase

See Also:

AccountingDocument.addSourceAccountingLine(SourceAccountingLine)

addTargetAccountingLine

public void addTargetAccountingLine(TargetAccountingLine targetLine)

Override to set the accounting line in the transaction detail object.

Specified by:

addTargetAccountingLine in interface AccountingDocument

Overrides:

addTargetAccountingLine in class AccountingDocumentBase

See Also:

AccountingDocument.addTargetAccountingLine(TargetAccountingLine)

getSourceAccountingLines

public List getSourceAccountingLines()

Override to get source accounting lines out of transactions

Specified by:

getSourceAccountingLines in interface AccountingDocument

Overrides:

getSourceAccountingLines in class AccountingDocumentBase

Returns:

The list of source accounting lines.

See Also:

AccountingDocument.getSourceAccountingLines()

getTargetAccountingLines

public List getTargetAccountingLines()

Override to get target accounting lines out of transactions

Specified by:

getTargetAccountingLines in interface AccountingDocument

Overrides:

getTargetAccountingLines in class AccountingDocumentBase

See Also:

AccountingDocument.getTargetAccountingLines()

getSourceAccountingLineClass

public Class getSourceAccountingLineClass()

Description copied from class: AccountingDocumentBase

Returns the default Source accounting line class.

Specified by:

getSourceAccountingLineClass in interface AccountingDocument

Overrides:

getSourceAccountingLineClass in class AccountingDocumentBase

See Also:

AccountingDocumentBase.getSourceAccountingLineClass()

getTargetAccountingLineClass

public Class getTargetAccountingLineClass()

Description copied from class: AccountingDocumentBase

Returns the default Target accounting line class.

Specified by:

getTargetAccountingLineClass in interface AccountingDocument

Overrides:

getTargetAccountingLineClass in class AccountingDocumentBase

See Also:

AccountingDocumentBase.getTargetAccountingLineClass()

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 CapitalAssetInformationDocumentBase

See Also:

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

isDebit

public boolean isDebit(GeneralLedgerPendingEntrySourceDetail postable)
                throws IllegalStateException

On procurement card documents, positive source amounts are credits, negative source amounts are debits.

Specified by:

isDebit in interface GeneralLedgerPendingEntrySource

Overrides:

isDebit in class CapitalAssetInformationDocumentBase

Parameters:

transactionalDocument - The document the accounting line being checked is located in.

accountingLine - The accounting line being analyzed.

Returns:

True if the accounting line given is a debit accounting line, false otherwise.

Throws:

Throws - an IllegalStateException if one of the following rules are violated: the accounting line amount is zero or the accounting line is not an expense or income accounting line.

IllegalStateException

See Also:

org.kuali.module.financial.rules.FinancialDocumentRuleBase#isDebit(FinancialDocument, org.kuali.rice.krad.bo.AccountingLine), org.kuali.ole.sys.document.validation.impl.AccountingDocumentRuleBase.IsDebitUtils#isDebitConsideringSection(AccountingDocumentRuleBase, AccountingDocument, AccountingLine)

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()

Returns:

CapitalAssetManagementModuleService