org.kuali.kra.budget.document

Class BudgetDocument<T extends BudgetParent>

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<T>

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

Direct Known Subclasses:

AwardBudgetDocument

public class BudgetDocument<T extends BudgetParent>
extends ResearchDocumentBase
implements org.kuali.rice.krad.document.Copyable, org.kuali.rice.krad.document.SessionDocument, Permissionable, BudgetDocumentTypeChecker

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

Method Summary

Methods

Modifier and Type	Method and Description
List	buildListOfDeletionAwareLists()
void	documentHasBeenRejected(String reason)
Budget	getBudget() This method returns Budget object.
Date	getBudgetEndDate()
List<Budget>	getBudgets() Gets the budgets attribute.
Date	getBudgetStartDate()
String	getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person user)
List<? extends DocumentCustomData>	getDocumentCustomData()
String	getDocumentKey() This method returns unique key for implementing document.
String	getDocumentNumberForPermission() This method returns the appropriate document number for implementing documents For award it would be awardNumber and for PDD it would be proposal Number.
String	getDocumentRoleTypeCode()
String	getDocumentTypeCode()
Integer	getHackedDocumentNextValue(String propertyName)
String	getLeadUnitNumber()
List<String>	getLockClearningMethodNames()
String	getNamespace()
BudgetParentDocument<T>	getParentDocument() Gets the parentDocument attribute.
String	getParentDocumentKey() Gets the parentDocumentKey attribute.
String	getParentDocumentTypeCode() Gets the parentDocumentTypeCode attribute.
String	getProposalBudgetFlag() This method returns 'Y' if its a proposal budget
List<String>	getRoleNames() This method gets all the role names for particular document.
void	initialize()
boolean	isBudgetDeleted()
boolean	isProcessComplete() Returns whether the post-processing is considered complete for this document.
void	prepareForSave()
void	processAfterRetrieve()
void	setBudgetDeleted(boolean budgetDeleted)
void	setBudgets(List<Budget> budgets) Sets the budgets attribute value.
void	setParentDocument(BudgetParentDocument<T> parentDocument) Sets the parentDocument attribute value.
void	setParentDocumentKey(String parentDocumentNumber) Sets the parentDocumentKey attribute value.
void	setParentDocumentTypeCode(String parentDocumentTypeCode) Sets the parentDocumentTypeCode attribute value.
boolean	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, doActionTaken, doRouteLevelChange, doRouteStatusChange, 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, doActionTaken, doRouteLevelChange, doRouteStatusChange, 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

BudgetDocument

public BudgetDocument()

Method Detail

processAfterRetrieve

public void processAfterRetrieve()

Specified by:

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

Overrides:

processAfterRetrieve in class ResearchDocumentBase

initialize

public void initialize()

Overrides:

initialize in class ResearchDocumentBase

getHackedDocumentNextValue

public Integer getHackedDocumentNextValue(String propertyName)

prepareForSave

public void prepareForSave()

Specified by:

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

Overrides:

prepareForSave in class ResearchDocumentBase

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

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

Overrides:

buildListOfDeletionAwareLists in class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

getParentDocument

public BudgetParentDocument<T> getParentDocument()

Gets the parentDocument attribute.

Returns:

Returns the parentDocument.

setParentDocument

public void setParentDocument(BudgetParentDocument<T> parentDocument)

Sets the parentDocument attribute value.

Parameters:

parentDocument - The parentDocument to set.

getBudgets

public List<Budget> getBudgets()

Gets the budgets attribute.

Returns:

Returns the budgets.

setBudgets

public void setBudgets(List<Budget> budgets)

Sets the budgets attribute value.

Parameters:

budgets - The budgets to set.

getBudget

public Budget getBudget()

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

Returns:

Budget

getDocumentTypeCode

public String getDocumentTypeCode()

Specified by:

getDocumentTypeCode in class ResearchDocumentBase

See Also:

ResearchDocumentBase.getDocumentTypeCode()

getParentDocumentKey

public String getParentDocumentKey()

Gets the parentDocumentKey attribute.

Returns:

Returns the parentDocumentKey.

setParentDocumentKey

public void setParentDocumentKey(String parentDocumentNumber)

Sets the parentDocumentKey attribute value.

Parameters:

parentDocumentKey - The parentDocumentKey to set.

getParentDocumentTypeCode

public String getParentDocumentTypeCode()

Gets the parentDocumentTypeCode attribute.

Returns:

Returns the parentDocumentTypeCode.

setParentDocumentTypeCode

public void setParentDocumentTypeCode(String parentDocumentTypeCode)

Sets the parentDocumentTypeCode attribute value.

Parameters:

parentDocumentTypeCode - The parentDocumentTypeCode to set.

useCustomLockDescriptors

public boolean useCustomLockDescriptors()

Specified by:

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

Overrides:

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

getCustomLockDescriptor

public String getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person user)

Specified by:

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

Overrides:

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

getDocumentKey

public String getDocumentKey()

Description copied from interface: Permissionable

This method returns unique key for implementing document.

Specified by:

getDocumentKey in interface Permissionable

Returns:

getDocumentNumberForPermission

public String getDocumentNumberForPermission()

Description copied from interface: Permissionable

This method returns the appropriate document number for implementing documents For award it would be awardNumber and for PDD it would be proposal Number.

Specified by:

getDocumentNumberForPermission in interface Permissionable

Returns:

getRoleNames

public List<String> getRoleNames()

Description copied from interface: Permissionable

This method gets all the role names for particular document.

Specified by:

getRoleNames in interface Permissionable

Returns:

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface Permissionable

getLeadUnitNumber

public String getLeadUnitNumber()

Specified by:

getLeadUnitNumber in interface Permissionable

getDocumentRoleTypeCode

public String getDocumentRoleTypeCode()

Specified by:

getDocumentRoleTypeCode in interface Permissionable

getProposalBudgetFlag

public String getProposalBudgetFlag()

Description copied from interface: BudgetDocumentTypeChecker

This method returns 'Y' if its a proposal budget

Specified by:

getProposalBudgetFlag in interface BudgetDocumentTypeChecker

Returns:

getLockClearningMethodNames

public List<String> getLockClearningMethodNames()

Specified by:

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

Overrides:

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

documentHasBeenRejected

public void documentHasBeenRejected(String reason)

isBudgetDeleted

public boolean isBudgetDeleted()

setBudgetDeleted

public void setBudgetDeleted(boolean budgetDeleted)

isProcessComplete

public boolean isProcessComplete()

Description copied from class: ResearchDocumentBase

Returns whether the post-processing is considered complete for this document.

Specified by:

isProcessComplete in class ResearchDocumentBase

Returns:

true if the post-processing is complete, false otherwise

getBudgetStartDate

public Date getBudgetStartDate()

getBudgetEndDate

public Date getBudgetEndDate()

getDocumentCustomData

public List<? extends DocumentCustomData> getDocumentCustomData()

Specified by:

getDocumentCustomData in class ResearchDocumentBase