org.kuali.ole.sys.document

Class LedgerPostingDocumentBase

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

All Implemented Interfaces:

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

Direct Known Subclasses:

GeneralLedgerPostingDocumentBase

public class LedgerPostingDocumentBase
extends FinancialSystemTransactionalDocumentBase
implements LedgerPostingDocument

Base implementation for a ledger posting document.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AccountingPeriod	accountingPeriod
protected static AccountingPeriodService	accountingPeriodService
protected boolean	checkPostingYearForCopy
protected static org.kuali.rice.kns.service.DataDictionaryService	dataDictionaryService
protected static org.kuali.rice.core.api.datetime.DateTimeService	dateTimeService
protected String	postingPeriodCode
protected Integer	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
LedgerPostingDocumentBase() Constructs a LedgerPostingDocumentBase.java.

Method Summary

Methods

Modifier and Type	Method and Description
void	createInitialAccountingPeriod() Used during initialization to provide a base AccountingPeriod.
AccountingPeriod	getAccountingPeriod() This method retrieves the accounting period associated with this document.
String	getAccountingPeriodCompositeString() Composite of postingPeriodCode and postingYear
static AccountingPeriodService	getAccountingPeriodService()
static org.kuali.rice.kns.service.DataDictionaryService	getDataDictionaryService()
static org.kuali.rice.core.api.datetime.DateTimeService	getDateTimeService()
String	getFinancialDocumentTypeCode() Returns the financial document type code for the given document, using the DataDictionaryService
String	getPostingPeriodCode() Gets the postingPeriodCode attribute.
Integer	getPostingYear()
AccountingPeriod	retrieveCurrentAccountingPeriod() Finds the accounting period for the current date
void	setAccountingPeriod(AccountingPeriod accountingPeriod) This method sets the accounting period associated with this document.
void	setAccountingPeriodCompositeString(String accountingPeriodString) Set accountingPeriod based on incoming paramater.
void	setPostingPeriodCode(String postingPeriodCode) Sets the postingPeriodCode attribute value.
void	setPostingYear(Integer postingYear) Sets the posting year for this document
void	toCopy() If we've copied, we need to update the posting period and year

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

answerSplitNodeQuestion, doRouteLevelChange, doRouteStatusChange, getApplicationDocumentStatus, getBusinessObjectService, getFinancialSystemDocumentHeader, getFinancialSystemDocumentService, getParameterService, prepareForSave, processAfterRetrieve, setApplicationDocumentStatus, setDocumentHeader, toErrorCorrection, 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, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, postProcessSave, prepareForSave, 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, buildListOfDeletionAwareLists, 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.FinancialSystemDocument

answerSplitNodeQuestion, getFinancialSystemDocumentHeader

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

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

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

buildListOfDeletionAwareLists, 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

Field Detail

dateTimeService

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

accountingPeriodService

protected static transient AccountingPeriodService accountingPeriodService

dataDictionaryService

protected static transient org.kuali.rice.kns.service.DataDictionaryService dataDictionaryService

accountingPeriod

protected AccountingPeriod accountingPeriod

postingYear

protected Integer postingYear

postingPeriodCode

protected String postingPeriodCode

checkPostingYearForCopy

protected boolean checkPostingYearForCopy

Constructor Detail

LedgerPostingDocumentBase

public LedgerPostingDocumentBase()

Constructs a LedgerPostingDocumentBase.java.

Method Detail

createInitialAccountingPeriod

public void createInitialAccountingPeriod()

Used during initialization to provide a base AccountingPeriod.

This is a hack right now because its intended to be set by the AccountingPeriodService

retrieveCurrentAccountingPeriod

public AccountingPeriod retrieveCurrentAccountingPeriod()

Finds the accounting period for the current date

Returns:

the current accounting period

getPostingYear

public Integer getPostingYear()

Specified by:

getPostingYear in interface LedgerPostingDocument

Returns:

posting year for this document

See Also:

LedgerPostingDocument.getPostingYear()

setPostingYear

public void setPostingYear(Integer postingYear)

Description copied from interface: LedgerPostingDocument

Sets the posting year for this document

Specified by:

setPostingYear in interface LedgerPostingDocument

See Also:

LedgerPostingDocument.setPostingYear(java.lang.Integer)

getPostingPeriodCode

public String getPostingPeriodCode()

Description copied from interface: LedgerPostingDocument

Gets the postingPeriodCode attribute. Part of AccountingPeriod Primary Key.

Specified by:

getPostingPeriodCode in interface LedgerPostingDocument

Returns:

Returns the postingPeriodCode.

See Also:

LedgerPostingDocument.getPostingPeriodCode()

setPostingPeriodCode

public void setPostingPeriodCode(String postingPeriodCode)

Description copied from interface: LedgerPostingDocument

Sets the postingPeriodCode attribute value. Part of AccountingPeriod Primary Key.

Specified by:

setPostingPeriodCode in interface LedgerPostingDocument

Parameters:

postingPeriodCode - The postingPeriodCode to set.

See Also:

LedgerPostingDocument.setPostingPeriodCode(java.lang.String)

getAccountingPeriod

public AccountingPeriod getAccountingPeriod()

Description copied from interface: LedgerPostingDocument

This method retrieves the accounting period associated with this document.

Specified by:

getAccountingPeriod in interface LedgerPostingDocument

See Also:

LedgerPostingDocument.getAccountingPeriod()

setAccountingPeriod

public void setAccountingPeriod(AccountingPeriod accountingPeriod)

Description copied from interface: LedgerPostingDocument

This method sets the accounting period associated with this document.

Specified by:

setAccountingPeriod in interface LedgerPostingDocument

See Also:

LedgerPostingDocument.setAccountingPeriod(AccountingPeriod)

toCopy

public void toCopy()
            throws org.kuali.rice.kew.api.exception.WorkflowException,
                   IllegalStateException

If we've copied, we need to update the posting period and year

Overrides:

toCopy in class FinancialSystemTransactionalDocumentBase

Throws:

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

IllegalStateException

See Also:

DocumentBase.toCopy()

getFinancialDocumentTypeCode

public String getFinancialDocumentTypeCode()

Returns the financial document type code for the given document, using the DataDictionaryService

Returns:

the financial document type code for the given document

getDataDictionaryService

public static org.kuali.rice.kns.service.DataDictionaryService getDataDictionaryService()

getDateTimeService

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

getAccountingPeriodService

public static AccountingPeriodService getAccountingPeriodService()

getAccountingPeriodCompositeString

public String getAccountingPeriodCompositeString()

Composite of postingPeriodCode and postingYear

Returns:

Return a composite of postingPeriodCode and postingYear

setAccountingPeriodCompositeString

public void setAccountingPeriodCompositeString(String accountingPeriodString)

Set accountingPeriod based on incoming paramater.

Parameters:

accountingPeriodString - in the form of [period][year]