org.kuali.kra.award.budget.document

Class AwardBudgetDocument

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.kra.document.ResearchDocumentBase

org.kuali.kra.budget.document.BudgetDocument<Award>

org.kuali.kra.award.budget.document.AwardBudgetDocument

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, BudgetDocumentTypeChecker, Permissionable, 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 AwardBudgetDocument
extends BudgetDocument<Award>

See Also:

Serialized Form

Field Summary

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

documentHeader, documentNumber

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

extension, versionNumber

Fields inherited from interface org.kuali.kra.common.permissions.Permissionable

AWARD_BUDGET_KEY, AWARD_KEY, COI_DISCLOSURE_KEY, COMMITTEE_KEY, COMMITTEE_SCHEDULE_KEY, IACUC_PROTOCOL_KEY, IACUC_PROTOCOL_ONLINE_REVIEW_KEY, NEGOTIATION_KEY, PROPOSAL_BUDGET_KEY, PROPOSAL_KEY, PROTOCOL_KEY, PROTOCOL_ONLINE_REVIEW_KEY, SPONSOR_HIREARCHY_KEY, SUBAWARD_KEY, TIME_AND_MONEY_KEY

Constructor Summary

Constructors

Constructor and Description
AwardBudgetDocument()

Method Summary

Methods

Modifier and Type	Method and Description
void	doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event) Added method to detect when the document is being approved from the initial node.
void	documentHasBeenRejected(String reason)
void	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange dto) Added mthod to enable change of status when the document changes KEW status.
AwardBudgetExt	getAwardBudget()
protected AwardBudgetService	getAwardBudgetService()
Budget	getBudget() This method returns Budget object.
Award	getCurrentAward() Gets the currentAward attribute.
String	getDocumentTypeCode()
BudgetDecimal	getObligatedTotal() Gets the obligatedAmount attribute.
BudgetParentDocument<Award>	getParentDocument() Gets the parentDocument attribute.
void	initialize()
void	prepareForSave()
void	setAwardBudgetService(AwardBudgetService awardBudgetService)
void	setCurrentAward(Award currentAward) Sets the currentAward attribute value.
void	setObligatedTotal(BudgetDecimal obligatedTotal) Sets the obligatedAmount attribute value.

Methods inherited from class org.kuali.kra.budget.document.BudgetDocument

buildListOfDeletionAwareLists, getBudgetEndDate, getBudgets, getBudgetStartDate, getCustomLockDescriptor, getDocumentCustomData, getDocumentKey, getDocumentNumberForPermission, getDocumentRoleTypeCode, getHackedDocumentNextValue, getLeadUnitNumber, getLockClearningMethodNames, getNamespace, getParentDocumentKey, getParentDocumentTypeCode, getProposalBudgetFlag, getRoleNames, isBudgetDeleted, isProcessComplete, processAfterRetrieve, setBudgetDeleted, setBudgets, setParentDocument, setParentDocumentKey, setParentDocumentTypeCode, useCustomLockDescriptors

Methods inherited from class org.kuali.kra.document.ResearchDocumentBase

answerSplitNodeQuestion, getAllRolePersons, getCustomAttributeDocument, getCustomAttributeDocuments, getDocumentNextValue, getDocumentNextvalueBo, getDocumentNextvalues, getService, getUpdateTimestamp, getUpdateUser, isViewOnly, populateAdditionalQualifiedRoleAttributes, setCustomAttributeDocuments, setDocumentNextvalues, setUpdateTimestamp, setUpdateUser, setViewOnly, toCopy, updateDocumentDescriptions, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization

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, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, postProcessSave, prepareForSave, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks

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.kra.common.permissions.Permissionable

populateAdditionalQualifiedRoleAttributes

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

addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doRouteLevelChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes

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

Constructor Detail

AwardBudgetDocument

public AwardBudgetDocument()

Method Detail

initialize

public void initialize()

Overrides:

initialize in class BudgetDocument<Award>

getParentDocument

public BudgetParentDocument<Award> getParentDocument()

Gets the parentDocument attribute.

Overrides:

getParentDocument in class BudgetDocument<Award>

Returns:

Returns the parentDocument.

getCurrentAward

public Award getCurrentAward()

Gets the currentAward attribute.

Returns:

Returns the currentAward.

setCurrentAward

public void setCurrentAward(Award currentAward)

Sets the currentAward attribute value.

Parameters:

currentAward - The currentAward to set.

getDocumentTypeCode

public String getDocumentTypeCode()

Overrides:

getDocumentTypeCode in class BudgetDocument<Award>

See Also:

ResearchDocumentBase.getDocumentTypeCode()

getBudget

public Budget getBudget()

This method returns Budget object. Creates new budget instance if the budgets list is empty

Overrides:

getBudget in class BudgetDocument<Award>

Returns:

Budget

getAwardBudget

public AwardBudgetExt getAwardBudget()

getObligatedTotal

public BudgetDecimal getObligatedTotal()

Gets the obligatedAmount attribute.

Returns:

Returns the obligatedAmount.

setObligatedTotal

public void setObligatedTotal(BudgetDecimal obligatedTotal)

Sets the obligatedAmount attribute value.

Parameters:

obligatedAmount - The obligatedAmount to set.

doRouteStatusChange

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

Added mthod to enable change of status when the document changes KEW status.

Specified by:

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

Overrides:

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

See Also:

DocumentBase.doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange)

doActionTaken

public void doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event)

Added method to detect when the document is being approved from the initial node. In this case the document is actually being re-submitted after a rejection. The award budget status then changes back to In Progress.

Specified by:

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

Overrides:

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

See Also:

DocumentBase.doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent)

documentHasBeenRejected

public void documentHasBeenRejected(String reason)

Overrides:

documentHasBeenRejected in class BudgetDocument<Award>

See Also:

BudgetDocument.documentHasBeenRejected(java.lang.String)

prepareForSave

public void prepareForSave()

Specified by:

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

Overrides:

prepareForSave in class BudgetDocument<Award>

getAwardBudgetService

protected AwardBudgetService getAwardBudgetService()

setAwardBudgetService

public void setAwardBudgetService(AwardBudgetService awardBudgetService)