org.kuali.kfs.gl.document
Class GeneralLedgerCorrectionProcessDocument

java.lang.Object
  extended by org.kuali.rice.kns.bo.BusinessObjectBase
      extended by org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          extended by org.kuali.rice.kns.document.DocumentBase
              extended by org.kuali.rice.kns.document.TransactionalDocumentBase
                  extended by org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase
                      extended by org.kuali.kfs.gl.document.GeneralLedgerCorrectionProcessDocument
All Implemented Interfaces:
Serializable, org.apache.ojb.broker.PersistenceBrokerAware, AmountTotaling, FinancialSystemTransactionalDocument, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.PersistableBusinessObject, org.kuali.rice.kns.document.Document, org.kuali.rice.kns.document.SessionDocument, org.kuali.rice.kns.document.TransactionalDocument
Direct Known Subclasses:
LaborCorrectionDocument

public class GeneralLedgerCorrectionProcessDocument
extends FinancialSystemTransactionalDocumentBase
implements AmountTotaling

The General Ledger Correction Document, a document that allows editing and processing of origin entry groups and the origin entries within them.

See Also:
Serialized Form

Field Summary
protected  org.kuali.rice.kns.util.KualiDecimal correctionBudgetTotalAmount
           
protected  List<CorrectionChangeGroup> correctionChangeGroup
           
protected  Integer correctionChangeGroupNextLineNumber
           
protected  org.kuali.rice.kns.util.KualiDecimal correctionCreditTotalAmount
           
protected  org.kuali.rice.kns.util.KualiDecimal correctionDebitTotalAmount
           
protected  boolean correctionFileDelete
           
protected  String correctionInputFileName
           
protected  String correctionOutputFileName
           
protected  Integer correctionRowCount
           
protected  String correctionScriptText
           
protected  boolean correctionSelection
           
protected  String correctionTypeCode
           
protected static org.apache.log4j.Logger LOG
           
 
Fields inherited from class org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase
documentHeader
 
Fields inherited from class org.kuali.rice.kns.document.DocumentBase
documentBusinessObject, documentNumber
 
Fields inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase
extension, versionNumber
 
Constructor Summary
GeneralLedgerCorrectionProcessDocument()
           
 
Method Summary
 void addCorrectionChangeGroup(CorrectionChangeGroup ccg)
          This method...
protected  String buildFileExtensionWithDate(Date date)
           
protected  boolean checkForExistingOutputDocument(String documentNumber)
          Returns true if an existing document like "glcp_output.docNum" is found.
 void doRouteLevelChange(org.kuali.rice.kew.dto.DocumentRouteLevelChangeDTO change)
          Waits for the event of the route level changing to "Approve" and at that point, saving all the entries as origin entries in a newly created origin entry group, then scrubbing those entries
 void doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent)
          This is the default implementation which checks for a different workflow statuses, and updates the Kuali status accordingly.
 org.kuali.rice.kns.util.KualiDecimal getCorrectionBudgetTotalAmount()
           
 List<CorrectionChangeGroup> getCorrectionChangeGroup()
           
 CorrectionChangeGroup getCorrectionChangeGroupItem(int groupNumber)
          This method...
 Integer getCorrectionChangeGroupNextLineNumber()
           
 org.kuali.rice.kns.util.KualiDecimal getCorrectionCreditTotalAmount()
           
 org.kuali.rice.kns.util.KualiDecimal getCorrectionDebitTotalAmount()
           
 boolean getCorrectionFileDelete()
           
 String getCorrectionInputFileName()
           
 String getCorrectionOutputFileName()
           
 Integer getCorrectionRowCount()
           
 boolean getCorrectionSelection()
           
 String getCorrectionTypeCode()
           
 String getMethod()
          Returns the editing method to use on the origin entries in the document, either "Manual Edit," "Using Criteria," "Remove Group from Processing," or "Not Available"
 String getSystem()
          Returns the source of the origin entries this document uses: either an uploaded file of origin entries or the database
 org.kuali.rice.kns.util.KualiDecimal getTotalDollarAmount()
          Returns the total dollar amount associated with this document
 void removeCorrectionChangeGroup(int changeNumber)
          This method...
 void setCorrectionBudgetTotalAmount(org.kuali.rice.kns.util.KualiDecimal correctionBudgetTotalAmount)
           
 void setCorrectionChangeGroup(List<CorrectionChangeGroup> correctionChangeGroup)
           
 void setCorrectionChangeGroupNextLineNumber(Integer correctionChangeGroupNextLineNumber)
           
 void setCorrectionCreditTotalAmount(org.kuali.rice.kns.util.KualiDecimal correctionCreditTotalAmount)
           
 void setCorrectionDebitTotalAmount(org.kuali.rice.kns.util.KualiDecimal correctionDebitTotalAmount)
           
 void setCorrectionFileDelete(boolean correctionFileDelete)
           
 void setCorrectionInputFileName(String correctionInputFileName)
           
 void setCorrectionOutputFileName(String correctionOutputFileName)
           
 void setCorrectionRowCount(Integer correctionRowCount)
           
 void setCorrectionSelection(boolean correctionSelection)
           
 void setCorrectionTypeCode(String correctionTypeCode)
           
 void setDocumentNumber(String documentNumber)
          Sets this document's document number, but also sets the document number on all children objects
protected  LinkedHashMap toStringMapper()
          Returns a Map representation of the primary key of this document
 
Methods inherited from class org.kuali.kfs.sys.document.FinancialSystemTransactionalDocumentBase
answerSplitNodeQuestion, getDocumentHeader, prepareForSave, processAfterRetrieve, setDocumentHeader, toErrorCorrection
 
Methods inherited from class org.kuali.rice.kns.document.TransactionalDocumentBase
getAllowsCopy, isSessionDocument
 
Methods inherited from class org.kuali.rice.kns.document.DocumentBase
addCopyErrorDocumentNote, addPessimisticLock, afterLookup, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postProcessSave, prepareForSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setNewDocumentHeader, setPessimisticLocks, toCopy, toString, toStringBuilder, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization
 
Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase
addNote, afterDelete, afterInsert, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, buildListOfDeletionAwareLists, deleteNote, getAttachmentService, getBoNote, getBoNotes, getExtension, getNoteService, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isAutoIncrementSet, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, setAutoIncrementSet, setBoNotes, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber, supportsBoNotes
 
Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase
prepareForWorkflow
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.kuali.rice.kns.document.Document
addPessimisticLock, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAllowsCopy, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentBusinessObject, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, refreshPessimisticLocks, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization
 
Methods inherited from interface org.kuali.rice.kns.bo.PersistableBusinessObject
addNote, buildListOfDeletionAwareLists, deleteNote, getBoNote, getBoNotes, getExtension, getObjectId, getVersionNumber, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber
 
Methods inherited from interface org.kuali.rice.kns.bo.BusinessObject
prepareForWorkflow, refresh
 
Methods inherited from interface org.apache.ojb.broker.PersistenceBrokerAware
afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate
 

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

correctionTypeCode

protected String correctionTypeCode

correctionSelection

protected boolean correctionSelection

correctionFileDelete

protected boolean correctionFileDelete

correctionRowCount

protected Integer correctionRowCount

correctionDebitTotalAmount

protected org.kuali.rice.kns.util.KualiDecimal correctionDebitTotalAmount

correctionCreditTotalAmount

protected org.kuali.rice.kns.util.KualiDecimal correctionCreditTotalAmount

correctionBudgetTotalAmount

protected org.kuali.rice.kns.util.KualiDecimal correctionBudgetTotalAmount

correctionInputFileName

protected String correctionInputFileName

correctionOutputFileName

protected String correctionOutputFileName

correctionScriptText

protected String correctionScriptText

correctionChangeGroupNextLineNumber

protected Integer correctionChangeGroupNextLineNumber

correctionChangeGroup

protected List<CorrectionChangeGroup> correctionChangeGroup
Constructor Detail

GeneralLedgerCorrectionProcessDocument

public GeneralLedgerCorrectionProcessDocument()
Method Detail

toStringMapper

protected LinkedHashMap toStringMapper()
Returns a Map representation of the primary key of this document

Overrides:
toStringMapper in class org.kuali.rice.kns.document.DocumentBase
Returns:
a Map that represents the database key of this document
See Also:
BusinessObjectBase.toStringMapper()

getMethod

public String getMethod()
Returns the editing method to use on the origin entries in the document, either "Manual Edit," "Using Criteria," "Remove Group from Processing," or "Not Available"

Returns:
the String representation of the method this document is using

getSystem

public String getSystem()
Returns the source of the origin entries this document uses: either an uploaded file of origin entries or the database

Returns:
a String with the name of the system in use

addCorrectionChangeGroup

public void addCorrectionChangeGroup(CorrectionChangeGroup ccg)
This method...

Parameters:
ccg -

removeCorrectionChangeGroup

public void removeCorrectionChangeGroup(int changeNumber)
This method...

Parameters:
changeNumber -

getCorrectionChangeGroupItem

public CorrectionChangeGroup getCorrectionChangeGroupItem(int groupNumber)
This method...

Parameters:
groupNumber -
Returns:

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.kew.dto.DocumentRouteStatusChangeDTO statusChangeEvent)
Description copied from class: FinancialSystemTransactionalDocumentBase
This is the default implementation which checks for a different workflow statuses, and updates the Kuali status accordingly.

Specified by:
doRouteStatusChange in interface org.kuali.rice.kns.document.Document
Overrides:
doRouteStatusChange in class FinancialSystemTransactionalDocumentBase
See Also:
org.kuali.rice.kns.document.Document#doRouteStatusChange()

checkForExistingOutputDocument

protected boolean checkForExistingOutputDocument(String documentNumber)
Returns true if an existing document like "glcp_output.docNum" is found.


doRouteLevelChange

public void doRouteLevelChange(org.kuali.rice.kew.dto.DocumentRouteLevelChangeDTO change)
Waits for the event of the route level changing to "Approve" and at that point, saving all the entries as origin entries in a newly created origin entry group, then scrubbing those entries

Specified by:
doRouteLevelChange in interface org.kuali.rice.kns.document.Document
Overrides:
doRouteLevelChange in class org.kuali.rice.kns.document.DocumentBase
Parameters:
cahnge - a representation of the route level changed that just occurred
See Also:
org.kuali.rice.kns.document.DocumentBase#handleRouteLevelChange(org.kuali.rice.kew.clientapp.vo.DocumentRouteLevelChangeDTO)

getTotalDollarAmount

public org.kuali.rice.kns.util.KualiDecimal getTotalDollarAmount()
Returns the total dollar amount associated with this document

Specified by:
getTotalDollarAmount in interface AmountTotaling
Returns:
if credit total is zero, debit total, otherwise credit total

setDocumentNumber

public void setDocumentNumber(String documentNumber)
Sets this document's document number, but also sets the document number on all children objects

Specified by:
setDocumentNumber in interface org.kuali.rice.kns.document.Document
Overrides:
setDocumentNumber in class org.kuali.rice.kns.document.DocumentBase
Parameters:
documentNumber - the document number for this document
See Also:
DocumentBase.setDocumentNumber(java.lang.String)

getCorrectionTypeCode

public String getCorrectionTypeCode()

setCorrectionTypeCode

public void setCorrectionTypeCode(String correctionTypeCode)

getCorrectionSelection

public boolean getCorrectionSelection()

setCorrectionSelection

public void setCorrectionSelection(boolean correctionSelection)

getCorrectionFileDelete

public boolean getCorrectionFileDelete()

setCorrectionFileDelete

public void setCorrectionFileDelete(boolean correctionFileDelete)

getCorrectionRowCount

public Integer getCorrectionRowCount()

setCorrectionRowCount

public void setCorrectionRowCount(Integer correctionRowCount)

getCorrectionChangeGroupNextLineNumber

public Integer getCorrectionChangeGroupNextLineNumber()

setCorrectionChangeGroupNextLineNumber

public void setCorrectionChangeGroupNextLineNumber(Integer correctionChangeGroupNextLineNumber)

getCorrectionDebitTotalAmount

public org.kuali.rice.kns.util.KualiDecimal getCorrectionDebitTotalAmount()

setCorrectionDebitTotalAmount

public void setCorrectionDebitTotalAmount(org.kuali.rice.kns.util.KualiDecimal correctionDebitTotalAmount)

getCorrectionCreditTotalAmount

public org.kuali.rice.kns.util.KualiDecimal getCorrectionCreditTotalAmount()

setCorrectionCreditTotalAmount

public void setCorrectionCreditTotalAmount(org.kuali.rice.kns.util.KualiDecimal correctionCreditTotalAmount)

getCorrectionBudgetTotalAmount

public org.kuali.rice.kns.util.KualiDecimal getCorrectionBudgetTotalAmount()

setCorrectionBudgetTotalAmount

public void setCorrectionBudgetTotalAmount(org.kuali.rice.kns.util.KualiDecimal correctionBudgetTotalAmount)

getCorrectionInputFileName

public String getCorrectionInputFileName()

setCorrectionInputFileName

public void setCorrectionInputFileName(String correctionInputFileName)

getCorrectionOutputFileName

public String getCorrectionOutputFileName()

setCorrectionOutputFileName

public void setCorrectionOutputFileName(String correctionOutputFileName)

getCorrectionChangeGroup

public List<CorrectionChangeGroup> getCorrectionChangeGroup()

setCorrectionChangeGroup

public void setCorrectionChangeGroup(List<CorrectionChangeGroup> correctionChangeGroup)

buildFileExtensionWithDate

protected String buildFileExtensionWithDate(Date date)


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.