org.kuali.kra.budget.document

Class BudgetParentDocument<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.BudgetParentDocument<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

AwardDocument, ProposalDevelopmentDocument

public abstract class BudgetParentDocument<T extends BudgetParent>
extends ResearchDocumentBase
implements BudgetVersionCollection, BudgetDocumentTypeChecker, Permissionable

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addNewBudgetVersion(BudgetDocument budgetDocument, String name, boolean isDescriptionUpdatable)
abstract org.kuali.rice.kns.web.ui.ExtraButton	configureReturnToParentTopButton()
BudgetDocumentVersion	getBudgetDocumentVersion(int selectedLine)
List<org.kuali.rice.kns.datadictionary.HeaderNavigation>	getBudgetHeaderNavigatorList()
abstract T	getBudgetParent()
abstract Permissionable	getBudgetPermissionable()
BudgetDocumentVersion	getFinalBudgetVersion()
Integer	getNextBudgetVersionNumber() This method gets the next budget version number for this proposal.
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Looks up and returns the ParameterService.
abstract Task	getParentAuthZTask(String taskName)
abstract String	getTaskGroupName()
abstract boolean	isComplete()
abstract void	processAfterRetrieveForBudget(BudgetDocument budgetDocument)
abstract void	saveBudgetFinalVersionStatus(BudgetDocument budgetDocument)

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

answerSplitNodeQuestion, getAllRolePersons, getCustomAttributeDocument, getCustomAttributeDocuments, getDocumentCustomData, getDocumentNextValue, getDocumentNextvalueBo, getDocumentNextvalues, getDocumentTypeCode, getService, getUpdateTimestamp, getUpdateUser, initialize, isProcessComplete, isViewOnly, populateAdditionalQualifiedRoleAttributes, prepareForSave, processAfterRetrieve, 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, 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, setDocumentHeader, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks, useCustomLockDescriptors

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.kra.budget.versions.BudgetVersionCollection

getBudgetDocumentVersions, refreshBudgetDocumentVersions, setBudgetDocumentVersions

Methods inherited from interface org.kuali.kra.budget.document.BudgetDocumentTypeChecker

getProposalBudgetFlag

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

getDocumentKey, getDocumentNumberForPermission, getDocumentRoleTypeCode, getLeadUnitNumber, getNamespace, getRoleNames, populateAdditionalQualifiedRoleAttributes

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

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

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

Constructor Detail

BudgetParentDocument

public BudgetParentDocument()

Method Detail

getParameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

Looks up and returns the ParameterService.

Returns:

the parameter service.

getFinalBudgetVersion

public BudgetDocumentVersion getFinalBudgetVersion()

getNextBudgetVersionNumber

public Integer getNextBudgetVersionNumber()

This method gets the next budget version number for this proposal. We can't use documentNextVersionNumber because that requires a save and we don't want to save the proposal development document before forwarding to the budget document.

Returns:

Integer

addNewBudgetVersion

public void addNewBudgetVersion(BudgetDocument budgetDocument,
                       String name,
                       boolean isDescriptionUpdatable)

getBudgetDocumentVersion

public BudgetDocumentVersion getBudgetDocumentVersion(int selectedLine)

getBudgetPermissionable

public abstract Permissionable getBudgetPermissionable()

isComplete

public abstract boolean isComplete()

saveBudgetFinalVersionStatus

public abstract void saveBudgetFinalVersionStatus(BudgetDocument budgetDocument)

processAfterRetrieveForBudget

public abstract void processAfterRetrieveForBudget(BudgetDocument budgetDocument)

getTaskGroupName

public abstract String getTaskGroupName()

getParentAuthZTask

public abstract Task getParentAuthZTask(String taskName)

configureReturnToParentTopButton

public abstract org.kuali.rice.kns.web.ui.ExtraButton configureReturnToParentTopButton()

getBudgetHeaderNavigatorList

public List<org.kuali.rice.kns.datadictionary.HeaderNavigation> getBudgetHeaderNavigatorList()

getBudgetParent

public abstract T getBudgetParent()