org.kuali.kra.award.budget

Class AwardBudgetForm

java.lang.Object

org.apache.struts.action.ActionForm

org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

org.kuali.rice.kns.web.struts.form.KualiForm

org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

org.kuali.kra.web.struts.form.KraTransactionalDocumentFormBase

org.kuali.kra.web.struts.form.BudgetVersionFormBase

org.kuali.kra.budget.web.struts.form.BudgetForm

org.kuali.kra.award.budget.AwardBudgetForm

All Implemented Interfaces:

Serializable, CostShareFunctions, Auditable, org.kuali.rice.kns.web.struts.form.pojo.PojoForm

public class AwardBudgetForm
extends BudgetForm

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

org.kuali.rice.kns.web.struts.form.KualiForm.TabState

Field Summary

Fields inherited from class org.kuali.kra.budget.web.struts.form.BudgetForm

BUDGET_NAME_KEY, VERSION_NUMBER_KEY

Fields inherited from class org.kuali.kra.web.struts.form.KraTransactionalDocumentFormBase

actionName, navigateTo

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

forcedReadOnlyFields

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

adHocActionRequestCodes, attachmentFile, documentActions, editingMode, suppressAllButtons

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

extraButtons

Fields inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

requiredNonEditableProperties

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

Constructors

Constructor and Description
AwardBudgetForm()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addExtraButton(String property, String source, String altText) This is a utility method to add a new button to the extra buttons collection.
protected AwardBudgetExt	findAwardBudgetExt(Long budgetId, List<Budget> allBudgets) This method finds a particular budget in the list of budgets based on the budget id.
String	getActionPrefix()
Award	getAward() This method returns the award associated with the award budget.
AwardBudgetDocument	getAwardBudgetDocument()
AwardBudgetPeriodSummaryCalculatedAmount	getAwardBudgetPeriodSummaryCalculatedAmount() Gets the awardBudgetPeriodSummaryCalculatedAmount attribute.
String	getAwardInMultipleNodeHierarchy() Gets the awardInMultipleNodeHierarchy attribute.
String	getBudgetParentId() Gets the budgetParentId attribute.
boolean	getCanModifyBudgetRates() This method determines if the budget rates are editable.
protected String	getDefaultDocumentTypeName()
List<org.kuali.rice.kns.web.ui.ExtraButton>	getExtraActionsButtons()
String	getFnARateFlagEditable() This method is to define whether FnA rate type is editable in Budget Overview panel.
protected org.kuali.rice.kns.web.ui.HeaderField	getHeaderDocCreateDate(org.kuali.rice.kew.api.WorkflowDocument parentWorkflowDocument)
protected org.kuali.rice.kns.web.ui.HeaderField	getHeaderDocInitiator(org.kuali.rice.kew.api.WorkflowDocument parentWorkflowDocument)
protected org.kuali.rice.kns.web.ui.HeaderField	getHeaderDocNumber()
protected org.kuali.rice.kns.web.ui.HeaderField	getHeaderDocStatus(org.kuali.rice.kew.api.WorkflowDocument parentWorkflowDocument)
org.kuali.rice.kns.datadictionary.HeaderNavigation[]	getHeaderNavigationTabs() This method makes sure that the Rates tab is not displayed for proposals in a hierarchy.
BudgetDecimal	getObligatedChange() This method returns the difference in the obligation total between this budget, and the previous.
BudgetDecimal	getObligatedTotal() This method returns the obligated total for this award budget, which is getPreviousObligatedTotal().add(getObligatedChange()).
BudgetDecimal	getPreviousObligatedTotal() This method returns the previous budget's obligation amount.
protected BudgetDecimal	getSumOfAllPreviousBudgetChanges(AwardBudgetExt curentAwardBudgetExt, List<Budget> allBudgets) This method sums up all the previous changes of the prior budget versions.
void	initialize() This method initialize all form variables
void	setAwardBudgetPeriodSummaryCalculatedAmount(AwardBudgetPeriodSummaryCalculatedAmount awardBudgetPeriodSummaryCalculatedAmount) Sets the awardBudgetPeriodSummaryCalculatedAmount attribute value.
void	setAwardInMultipleNodeHierarchy(String awardInMultipleNodeHierarchy) Sets the awardInMultipleNodeHierarchy attribute value.
void	setBudgetParentId(String budgetParentId) Sets the budgetParentId attribute value.

Methods inherited from class org.kuali.kra.budget.web.struts.form.BudgetForm

addExtraButton, buildExtraButtonSourceURI, getBudgetDocument, getBudgetEndDate, getBudgetJustification, getBudgetModularSummary, getBudgetStartDate, getCostSharingAmount, getEnableBudgetSalaryByPeriod, getExtraButtons, getExtraExpensesButtons, getExtraPersonnelBudgetButtons, getExtraPersonnelButtons, getExtraTopButtons, getExtraTotalsTopButtons, getHierarchyPersonnelSummaries, getHierarchyProposalSummaries, getLockRegion, getModularSelectedPeriod, getNewBudgetCostShare, getNewBudgetFormulatedCost, getNewBudgetLineItems, getNewBudgetModularIdc, getNewBudgetPeriod, getNewBudgetPeriodNumber, getNewBudgetPersonnelDetails, getNewBudgetPersons, getNewBudgetProjectIncome, getNewBudgetRolodexes, getNewBudgetUnrecoveredFandA, getNewGroupName, getNewSubAward, getNewTbnPersons, getOhRateClassCodePrevValue, getPersonIndex, getPersonnelBudgetViewMode, getPersonnelDetailLine, getPrevOnOffCampusFlag, getProjectPeriodLabel, getProposalHierarchyService, getRatesExtraButtons, getSelectedBudgetLineItem, getSelectedBudgetLineItemIndex, getSelectedBudgetPrintFormId, getSelectedToPrintComment, getSyncBudgetRate, getUrRateClassCodePrevValue, getViewBudgetPeriod, getViewBudgetView, getViewLocation, isCostSharingEditFormVisible, isDocumentNextValueRefresh, isSaveAfterCopy, isSyncableBudget, isUnrecoveredFandAEditFormVisible, isUpdateFinalVersion, isViewDivBooleanFlag, isViewDivFlag, populate, populateHeaderFields, reset, setBudgetModularSummary, setCostSharingAmount, setDocumentNextValueRefresh, setEnableBudgetSalaryByPeriod, setExtraTopButtons, setHierarchyPersonnelSummaries, setHierarchyProposalSummaries, setModularSelectedPeriod, setNewBudgetCostShare, setNewBudgetFormulatedCost, setNewBudgetLineItems, setNewBudgetModularIdc, setNewBudgetPeriod, setNewBudgetPeriodNumber, setNewBudgetPersonnelDetails, setNewBudgetPersons, setNewBudgetProjectIncome, setNewBudgetRolodexes, setNewBudgetUnrecoveredFandA, setNewGroupName, setNewSubAward, setNewTbnPersons, setOhRateClassCodePrevValue, setPersonIndex, setPersonnelBudgetViewMode, setPersonnelDetailLine, setPrevOnOffCampusFlag, setProposalHierarchyService, setSaveAfterCopy, setSaveDocumentControl, setSelectedBudgetLineItem, setSelectedBudgetLineItemIndex, setSelectedBudgetPrintFormId, setSelectedToPrintComment, setSyncBudgetRate, setUpdateFinalVersion, setUrRateClassCodePrevValue, setViewBudgetPeriod, setViewBudgetView, setViewDivBooleanFlag, setViewDivFlag, setViewLocation, suppressButtonsForTotalPage, toBudgetVersionsPage

Methods inherited from class org.kuali.kra.web.struts.form.BudgetVersionFormBase

getActivePanelName, getAwardBudgetInactiveStatuses, getFinalBudgetVersion, getFormattedEndDate, getFormattedStartDate, getHierarchyChildStatus, getHierarchyNoneStatus, getHierarchyParentStatus, getLookedUpCollectionName, getLookupResultsBOClassName, getLookupResultsSequenceNumber, getNewBudgetVersionName, getProposalHierarchyIndirectObjectCode, isAuditActivated, isShowAllBudgetVersions, setActivePanelName, setAuditActivated, setFinalBudgetVersion, setLookedUpCollectionName, setLookupResultsBOClassName, setLookupResultsSequenceNumber, setNewBudgetVersionName, setProposalHierarchyIndirectObjectCode, setShowAllBudgetVersions

Methods inherited from class org.kuali.kra.web.struts.form.KraTransactionalDocumentFormBase

clearUnitRulesMessages, getActionName, getHeaderDispatch, getModuleCode, getNavigateTo, getPersonEditableFields, getSoftErrors, getUnitRulesErrors, getUnitRulesMessages, getUnitRulesMessages, getUnitRulesWarnings, hasModifyBudgetPermission, hasModifyCompletedBudgetPermission, hasModifyNarrativesPermission, hasModifyProposalPermission, isMedusaOpenedDoc, isPopupViewOnly, isUnitRulesErrorsExist, isUnitRulesWarningsExist, isViewOnly, populateFalseCheckboxes, populatePersonEditableFields, processMultiQuestionCheckBox, setActionName, setDocument, setMedusaOpenedDoc, setNavigateTo, setPersonEditableFields, setPopupViewOnly, setUnitRulesMessages, setupLockRegions, setViewOnly

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

discoverDocumentTypeName, formatReversalDate, getForcedReadOnlyFields, getTransactionalDocument, instantiateTransactionalDocumentByDocumentTypeName, populateEmptyMultiSelect, populationSpecialEmptyFields, setForcedReadOnlyFields, shouldMethodToCallParameterBeUsed

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

addRequiredNonEditableProperties, buildHtmlLink, customInitMaxUploadSizes, getActionRequests, getActionRequestsRequiringApproval, getAdditionalScriptFile, getAdditionalScriptFiles, getAdHocActionRequestCodes, getAdHocRoutePerson, getAdHocRoutePersons, getAdHocRouteWorkgroup, getAdHocRouteWorkgroups, getAnnotation, getAttachmentFile, getBoNotes, getCommand, getDocId, getDocNum, getDocTypeName, getDocument, getDocumentActions, getDocumentHandlerUrl, getEditingMode, getFormKey, getInitiator, getInitiatorNetworkId, getMessageMapFromPreviousRequest, getNewAdHocRoutePerson, getNewAdHocRouteWorkgroup, getNewNote, getPersonInquiryUrlLink, getSelectedActionRequests, getStandardHeaderFields, getSuperUserAnnotation, getWorkflowDocument, hasDocumentId, initializeHeaderNavigationTabs, instantiateDocument, isDocumentEnRoute, isFormDocumentInitialized, isHasWorkflowDocument, isReturnToActionList, isStateAllowsApproveOrDisapprove, isStateAllowsApproveSingleActionRequest, isStateInitiatedFinalCancelled, isStateProcessedOrDisapproved, isSuperUserActionAvaliable, isSuperUserApproveDocumentAuthorized, isSuperUserApproveSingleActionRequestAuthorized, isSuperUserAuthorized, isSuperUserDisapproveDocumentAuthorized, isSuppressAllButtons, isUserDocumentInitiator, setActionRequests, setAdditionalScriptFile, setAdditionalScriptFiles, setAdHocActionRequestCodes, setAdHocRoutePersons, setAdHocRouteWorkgroups, setAnnotation, setAttachmentFile, setBoNotes, setCommand, setDerivedValuesOnForm, setDocId, setDocNum, setDocTypeName, setDocumentActions, setEditingMode, setFormKey, setMessageMapFromPreviousRequest, setNewAdHocRoutePerson, setNewAdHocRouteWorkgroup, setNewNote, setReturnToActionList, setSelectedActionRequests, setSuperUserAnnotation, setSuppressAllButtons, shouldPropertyBePopulatedInForm, validate

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

clearEditablePropertyInformation, getActionFormUtilMap, getAnchor, getBackLocation, getCurrentTabIndex, getDisplayedErrors, getDisplayedInfo, getDisplayedWarnings, getDocInfo, getExtraButton, getFieldNameToFocusOnAfterSubmit, getMethodToCall, getNavigationCss, getNextArbitrarilyHighIndex, getNumColumns, getRefreshCaller, getTabState, getTabStates, incrementTabIndex, isFieldLevelHelpEnabled, populateBackLocation, populateFieldLevelHelpEnabled, reset, retrieveFormValueForLookupInquiryParameters, setActionFormUtilMap, setAnchor, setBackLocation, setCurrentTabIndex, setDocInfo, setExtraButton, setExtraButtons, setFieldLevelHelpEnabled, setFieldNameToFocusOnAfterSubmit, setHeaderNavigationTabs, setMethodToCall, setNavigationCss, setNumColumns, setRefreshCaller, setTabStates

Methods inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, formatterClassForKeypath, formatValue, getActionEditablePropertiesGuid, getEditableProperties, getFormatter, getFormatterTypes, getIsNewForm, getMaxUploadSizes, getMethodToCallsToBypassSessionRetrievalForGETRequests, getParameter, getParameterValues, getPopulateEditableProperties, getPopulateEditablePropertiesGuid, getPropertyType, getRequiredNonEditableProperties, getStrutsActionMappingScope, getUnconvertedValues, getUnknownKeys, initMaxUploadSizes, isPropertyEditable, isPropertyNonEditableButRequired, populateForProperty, postprocessRequestParameters, processValidationFail, registerEditableProperty, registerIsNewForm, registerRequiredNonEditableProperty, registerStrutsActionMappingScope, setActionEditablePropertiesGuid, setFormatterType, setFormatterTypes, setPopulateEditablePropertiesGuid, setUnconvertedValues

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, setMultipartRequestHandler, setServlet, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AwardBudgetForm

public AwardBudgetForm()

Method Detail

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Overrides:

getDefaultDocumentTypeName in class BudgetForm

initialize

public void initialize()

Description copied from class: BudgetForm

This method initialize all form variables

Overrides:

initialize in class BudgetForm

getAwardInMultipleNodeHierarchy

public String getAwardInMultipleNodeHierarchy()

Gets the awardInMultipleNodeHierarchy attribute.

Returns:

Returns the awardInMultipleNodeHierarchy.

setAwardInMultipleNodeHierarchy

public void setAwardInMultipleNodeHierarchy(String awardInMultipleNodeHierarchy)

Sets the awardInMultipleNodeHierarchy attribute value.

Parameters:

awardInMultipleNodeHierarchy - The awardInMultipleNodeHierarchy to set.

getActionPrefix

public String getActionPrefix()

Overrides:

getActionPrefix in class BudgetForm

getAwardBudgetDocument

public AwardBudgetDocument getAwardBudgetDocument()

getExtraActionsButtons

public List<org.kuali.rice.kns.web.ui.ExtraButton> getExtraActionsButtons()

Overrides:

getExtraActionsButtons in class BudgetForm

addExtraButton

protected void addExtraButton(String property,
                  String source,
                  String altText)

This is a utility method to add a new button to the extra buttons collection.

Overrides:

addExtraButton in class BudgetForm

Parameters:

property -

source -

altText -

setBudgetParentId

public void setBudgetParentId(String budgetParentId)

Sets the budgetParentId attribute value.

Parameters:

budgetParentId - The budgetParentId to set.

getBudgetParentId

public String getBudgetParentId()

Gets the budgetParentId attribute.

Returns:

Returns the budgetParentId.

getFnARateFlagEditable

public String getFnARateFlagEditable()

This method is to define whether FnA rate type is editable in Budget Overview panel.

Returns:

true if any FnA rates defined in award

getHeaderDocNumber

protected org.kuali.rice.kns.web.ui.HeaderField getHeaderDocNumber()

Overrides:

getHeaderDocNumber in class BudgetForm

getHeaderDocStatus

protected org.kuali.rice.kns.web.ui.HeaderField getHeaderDocStatus(org.kuali.rice.kew.api.WorkflowDocument parentWorkflowDocument)

Overrides:

getHeaderDocStatus in class BudgetForm

getHeaderDocInitiator

protected org.kuali.rice.kns.web.ui.HeaderField getHeaderDocInitiator(org.kuali.rice.kew.api.WorkflowDocument parentWorkflowDocument)

Overrides:

getHeaderDocInitiator in class BudgetForm

getHeaderDocCreateDate

protected org.kuali.rice.kns.web.ui.HeaderField getHeaderDocCreateDate(org.kuali.rice.kew.api.WorkflowDocument parentWorkflowDocument)

Overrides:

getHeaderDocCreateDate in class BudgetForm

getAwardBudgetPeriodSummaryCalculatedAmount

public AwardBudgetPeriodSummaryCalculatedAmount getAwardBudgetPeriodSummaryCalculatedAmount()

Gets the awardBudgetPeriodSummaryCalculatedAmount attribute.

Returns:

Returns the awardBudgetPeriodSummaryCalculatedAmount.

setAwardBudgetPeriodSummaryCalculatedAmount

public void setAwardBudgetPeriodSummaryCalculatedAmount(AwardBudgetPeriodSummaryCalculatedAmount awardBudgetPeriodSummaryCalculatedAmount)

Sets the awardBudgetPeriodSummaryCalculatedAmount attribute value.

Parameters:

awardBudgetPeriodSummaryCalculatedAmount - The awardBudgetPeriodSummaryCalculatedAmount to set.

getHeaderNavigationTabs

public org.kuali.rice.kns.datadictionary.HeaderNavigation[] getHeaderNavigationTabs()

Description copied from class: BudgetForm

This method makes sure that the Rates tab is not displayed for proposals in a hierarchy.

Overrides:

getHeaderNavigationTabs in class BudgetForm

Returns:

Returns the headerNavigationTabs filtered based on hierarchy status.

See Also:

KualiForm.getHeaderNavigationTabs()

getCanModifyBudgetRates

public boolean getCanModifyBudgetRates()

Description copied from class: BudgetForm

This method determines if the budget rates are editable. Note, this function should be overriden if this form gets extended. Such as in the case of AwardBudgetForm, as that form has different requirements for editing budget rates.

Overrides:

getCanModifyBudgetRates in class BudgetForm

Returns:

See Also:

BudgetForm.getCanModifyBudgetRates()

getAward

public Award getAward()

This method returns the award associated with the award budget.

Returns:

getObligatedTotal

public BudgetDecimal getObligatedTotal()

This method returns the obligated total for this award budget, which is getPreviousObligatedTotal().add(getObligatedChange()).

Returns:

getPreviousObligatedTotal

public BudgetDecimal getPreviousObligatedTotal()

This method returns the previous budget's obligation amount.

Returns:

getSumOfAllPreviousBudgetChanges

protected BudgetDecimal getSumOfAllPreviousBudgetChanges(AwardBudgetExt curentAwardBudgetExt,
                                             List<Budget> allBudgets)

This method sums up all the previous changes of the prior budget versions.

Parameters:

curentAwardBudgetExt -

allBudgets -

Returns:

findAwardBudgetExt

protected AwardBudgetExt findAwardBudgetExt(Long budgetId,
                                List<Budget> allBudgets)

This method finds a particular budget in the list of budgets based on the budget id. If no budget is found, a null is returned.

Parameters:

budgetId -

allBudgets -

Returns:

getObligatedChange

public BudgetDecimal getObligatedChange()

This method returns the difference in the obligation total between this budget, and the previous.

Returns: