org.kuali.kra.institutionalproposal.web.struts.form

Class InstitutionalProposalForm

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.institutionalproposal.web.struts.form.InstitutionalProposalForm

All Implemented Interfaces:

Serializable, ReportHelperBeanContainer, Auditable, CustomDataDocumentForm, MultiLookupFormBase, org.kuali.rice.kns.web.struts.form.pojo.PojoForm

public class InstitutionalProposalForm
extends KraTransactionalDocumentFormBase
implements Auditable, MultiLookupFormBase, ReportHelperBeanContainer, CustomDataDocumentForm

This class...

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.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
InstitutionalProposalForm() Constructs a AwardForm.

Method Summary

Methods

Modifier and Type	Method and Description
String	getActionName()
InstitutionalProposalCentralAdminContactsBean	getCentralAdminContactsBean()
InstitutionalProposalCustomDataFormHelper	getCustomDataHelper() Gets the institutionalProposalCustomDataFormHelper attribute.
protected org.kuali.rice.kns.service.DataDictionaryService	getDataDictionaryService() This method is a wrapper method for getting DataDictionary Service using the Service Locator.
protected String	getDefaultDocumentTypeName()
boolean	getDisplayEditButton()
String	getDocumentTypeName() This method returns a string representation of the document type
List<org.kuali.rice.kns.web.ui.ExtraButton>	getExtraActionsButtons()
org.kuali.rice.kns.datadictionary.HeaderNavigation[]	getHeaderNavigationTabs()
InstitutionalProposalCostShareBean	getInstitutionalProposalCostShareBean() Gets the institutionalProposalCostShareBean attribute.
InstitutionalProposalCreditSplitBean	getInstitutionalProposalCreditSplitBean() Gets the institutionalProposalCreditSplitBean attribute.
InstitutionalProposalCustomDataFormHelper	getInstitutionalProposalCustomDataFormHelper() Gets the institutionalProposalCustomDataFormHelper attribute.
InstitutionalProposalDocument	getInstitutionalProposalDocument() This method returns the AwardDocument object.
InstitutionalProposalNotepadBean	getInstitutionalProposalNotepadBean() Gets the institutionalProposalNotepadBean attribute.
InstitutionalProposalUnrecoveredFandABean	getInstitutionalProposalUnrecoveredFandABean() Gets the institutionalProposalUnrecoveredFandABean attribute.
protected String	getLockRegion()
String	getLookupResultsBOClassName() Gets the lookupResultsBOClassName attribute.
String	getLookupResultsSequenceNumber() Gets the lookupResultsSequenceNumber attribute.
MedusaBean	getMedusaBean() Gets the medusaBean attribute.
NotificationHelper<InstitutionalProposalNotificationContext>	getNotificationHelper() Gets the notificationHelper attribute.
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
InstitutionalProposalProjectPersonnelBean	getProjectPersonnelBean() Gets the projectPersonnelBean attribute.
String	getProposalNumber()
ReportHelperBean	getReportHelperBean()
String[]	getSelectedAwardFundingProposals()
String	getSelectedLeadUnit()
SpecialReviewHelper	getSpecialReviewHelper() Gets the Special Review Helper.
InstitutionalProposalUnitContactsBean	getUnitContactsBean()
String	getValueFinderResultCache()
String	getValueFinderResultDoNotCache()
boolean	getViewFundingSource()
void	initialize() This method initialize all form variables
boolean	isAuditActivated() Gets whether or not audit has been activated.
boolean	isCfdaLookupRequired()
boolean	isDocOpenedFromIPSearch()
void	setAuditActivated(boolean auditActivated) Sets whether or not audit has been activated.
void	setDocOpenedFromIPSearch(boolean docOpened)
void	setInstitutionalProposalCostShareBean(InstitutionalProposalCostShareBean institutionalProposalCostShareBean) Sets the institutionalProposalCostShareBean attribute value.
void	setInstitutionalProposalCreditSplitBean(InstitutionalProposalCreditSplitBean institutionalProposalCreditSplitBean) Sets the institutionalProposalCreditSplitBean attribute value.
void	setInstitutionalProposalCustomDataFormHelper(InstitutionalProposalCustomDataFormHelper institutionalProposalCustomDataFormHelper) Sets the institutionalProposalCustomDataFormHelper attribute value.
void	setInstitutionalProposalNotepadBean(InstitutionalProposalNotepadBean institutionalProposalNotepadBean) Sets the institutionalProposalNotepadBean attribute value.
void	setInstitutionalProposalUnrecoveredFandABean(InstitutionalProposalUnrecoveredFandABean institutionalProposalUnrecoveredFandABean) Sets the institutionalProposalUnrecoveredFandABean attribute value.
void	setLookupResultsBOClassName(String lookupResultsBOClassName) Sets the lookupResultsBOClassName attribute value.
void	setLookupResultsSequenceNumber(String lookupResultsSequenceNumber) Sets the lookupResultsSequenceNumber attribute value.
void	setMedusaBean(MedusaBean medusaBean) Sets the medusaBean attribute value.
void	setNotificationHelper(NotificationHelper<InstitutionalProposalNotificationContext> notificationHelper) Sets the notificationHelper attribute value.
void	setProjectPersonnelBean(InstitutionalProposalProjectPersonnelBean projectPersonnelBean) Sets the projectPersonnelBean attribute value.
void	setProposalNumber(String proposalNumber)
protected void	setSaveDocumentControl(Map editMode)
void	setSelectedAwardFundingProposals(String[] selectedAwardFundingProposals)
void	setSelectedLeadUnit(String unitName)
void	setSpecialReviewHelper(SpecialReviewHelper specialReviewHelper) Sets the Special Review Helper.
void	setViewFundingSource(boolean viewFundingSource)

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

addExtraButton, clearUnitRulesMessages, getHeaderDispatch, getModuleCode, getNavigateTo, getPersonEditableFields, getSoftErrors, getUnitRulesErrors, getUnitRulesMessages, getUnitRulesMessages, getUnitRulesWarnings, hasModifyBudgetPermission, hasModifyCompletedBudgetPermission, hasModifyNarrativesPermission, hasModifyProposalPermission, isMedusaOpenedDoc, isPopupViewOnly, isUnitRulesErrorsExist, isUnitRulesWarningsExist, isViewOnly, populate, 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, populateHeaderFields, reset, 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, getExtraButtons, 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

Methods inherited from interface org.kuali.kra.web.struts.form.MultiLookupFormBase

getRefreshCaller

Constructor Detail

InstitutionalProposalForm

public InstitutionalProposalForm()

Constructs a AwardForm.

Method Detail

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Specified by:

getDefaultDocumentTypeName in class KraTransactionalDocumentFormBase

initialize

public void initialize()

This method initialize all form variables

getInstitutionalProposalDocument

public InstitutionalProposalDocument getInstitutionalProposalDocument()

This method returns the AwardDocument object.

Returns:

getDocumentTypeName

public String getDocumentTypeName()

This method returns a string representation of the document type

Returns:

getSpecialReviewHelper

public SpecialReviewHelper getSpecialReviewHelper()

Gets the Special Review Helper.

Returns:

the Special Review Helper

setSpecialReviewHelper

public void setSpecialReviewHelper(SpecialReviewHelper specialReviewHelper)

Sets the Special Review Helper.

Parameters:

specialReviewHelper - the Special Review Helper

getCustomDataHelper

public InstitutionalProposalCustomDataFormHelper getCustomDataHelper()

Gets the institutionalProposalCustomDataFormHelper attribute.

Specified by:

getCustomDataHelper in interface CustomDataDocumentForm

Returns:

Returns the institutionalProposalCustomDataFormHelper.

getInstitutionalProposalCustomDataFormHelper

public InstitutionalProposalCustomDataFormHelper getInstitutionalProposalCustomDataFormHelper()

Gets the institutionalProposalCustomDataFormHelper attribute.

Returns:

Returns the institutionalProposalCustomDataFormHelper.

setInstitutionalProposalCustomDataFormHelper

public void setInstitutionalProposalCustomDataFormHelper(InstitutionalProposalCustomDataFormHelper institutionalProposalCustomDataFormHelper)

Sets the institutionalProposalCustomDataFormHelper attribute value.

Parameters:

institutionalProposalCustomDataFormHelper - The institutionalProposalCustomDataFormHelper to set.

getNotificationHelper

public NotificationHelper<InstitutionalProposalNotificationContext> getNotificationHelper()

Gets the notificationHelper attribute.

Returns:

Returns the notificationHelper.

setNotificationHelper

public void setNotificationHelper(NotificationHelper<InstitutionalProposalNotificationContext> notificationHelper)

Sets the notificationHelper attribute value.

Parameters:

notificationHelper - The notificationHelper to set.

getInstitutionalProposalNotepadBean

public InstitutionalProposalNotepadBean getInstitutionalProposalNotepadBean()

Gets the institutionalProposalNotepadBean attribute.

Returns:

Returns the institutionalProposalNotepadBean.

setInstitutionalProposalNotepadBean

public void setInstitutionalProposalNotepadBean(InstitutionalProposalNotepadBean institutionalProposalNotepadBean)

Sets the institutionalProposalNotepadBean attribute value.

Parameters:

institutionalProposalNotepadBean - The institutionalProposalNotepadBean to set.

getProjectPersonnelBean

public InstitutionalProposalProjectPersonnelBean getProjectPersonnelBean()

Gets the projectPersonnelBean attribute.

Returns:

Returns the projectPersonnelBean.

setProjectPersonnelBean

public void setProjectPersonnelBean(InstitutionalProposalProjectPersonnelBean projectPersonnelBean)

Sets the projectPersonnelBean attribute value.

Parameters:

projectPersonnelBean - The projectPersonnelBean to set.

getUnitContactsBean

public InstitutionalProposalUnitContactsBean getUnitContactsBean()

getCentralAdminContactsBean

public InstitutionalProposalCentralAdminContactsBean getCentralAdminContactsBean()

Returns:

getInstitutionalProposalCreditSplitBean

public InstitutionalProposalCreditSplitBean getInstitutionalProposalCreditSplitBean()

Gets the institutionalProposalCreditSplitBean attribute.

Returns:

Returns the institutionalProposalCreditSplitBean.

setInstitutionalProposalCreditSplitBean

public void setInstitutionalProposalCreditSplitBean(InstitutionalProposalCreditSplitBean institutionalProposalCreditSplitBean)

Sets the institutionalProposalCreditSplitBean attribute value.

Parameters:

institutionalProposalCreditSplitBean - The institutionalProposalCreditSplitBean to set.

getInstitutionalProposalCostShareBean

public InstitutionalProposalCostShareBean getInstitutionalProposalCostShareBean()

Gets the institutionalProposalCostShareBean attribute.

Returns:

Returns the institutionalProposalCostShareBean.

setInstitutionalProposalCostShareBean

public void setInstitutionalProposalCostShareBean(InstitutionalProposalCostShareBean institutionalProposalCostShareBean)

Sets the institutionalProposalCostShareBean attribute value.

Parameters:

institutionalProposalCostShareBean - The institutionalProposalCostShareBean to set.

getInstitutionalProposalUnrecoveredFandABean

public InstitutionalProposalUnrecoveredFandABean getInstitutionalProposalUnrecoveredFandABean()

Gets the institutionalProposalUnrecoveredFandABean attribute.

Returns:

Returns the institutionalProposalUnrecoveredFandABean.

setInstitutionalProposalUnrecoveredFandABean

public void setInstitutionalProposalUnrecoveredFandABean(InstitutionalProposalUnrecoveredFandABean institutionalProposalUnrecoveredFandABean)

Sets the institutionalProposalUnrecoveredFandABean attribute value.

Parameters:

institutionalProposalUnrecoveredFandABean - The institutionalProposalUnrecoveredFandABean to set.

getActionName

public String getActionName()

Overrides:

getActionName in class KraTransactionalDocumentFormBase

getSelectedLeadUnit

public String getSelectedLeadUnit()

Returns:

The selected lead unit

setSelectedLeadUnit

public void setSelectedLeadUnit(String unitName)

Parameters:

unitName -

getDataDictionaryService

protected org.kuali.rice.kns.service.DataDictionaryService getDataDictionaryService()

This method is a wrapper method for getting DataDictionary Service using the Service Locator.

Returns:

getLockRegion

protected String getLockRegion()

Specified by:

getLockRegion in class KraTransactionalDocumentFormBase

See Also:

KraTransactionalDocumentFormBase.getLockRegion()

setSaveDocumentControl

protected void setSaveDocumentControl(Map editMode)

Specified by:

setSaveDocumentControl in class KraTransactionalDocumentFormBase

See Also:

KraTransactionalDocumentFormBase.setSaveDocumentControl(java.util.Map)

isAuditActivated

public boolean isAuditActivated()

Gets whether or not audit has been activated.

Specified by:

isAuditActivated in interface Auditable

Returns:

true if audit is activated false if not.

setAuditActivated

public void setAuditActivated(boolean auditActivated)

Sets whether or not audit has been activated.

Specified by:

setAuditActivated in interface Auditable

Parameters:

auditActivated - true if audit is activated false if not.

getLookupResultsSequenceNumber

public String getLookupResultsSequenceNumber()

Gets the lookupResultsSequenceNumber attribute.

Specified by:

getLookupResultsSequenceNumber in interface MultiLookupFormBase

Returns:

Returns the lookupResultsSequenceNumber.

setLookupResultsSequenceNumber

public void setLookupResultsSequenceNumber(String lookupResultsSequenceNumber)

Sets the lookupResultsSequenceNumber attribute value.

Parameters:

lookupResultsSequenceNumber - The lookupResultsSequenceNumber to set.

getLookupResultsBOClassName

public String getLookupResultsBOClassName()

Gets the lookupResultsBOClassName attribute.

Specified by:

getLookupResultsBOClassName in interface MultiLookupFormBase

Returns:

Returns the lookupResultsBOClassName.

setLookupResultsBOClassName

public void setLookupResultsBOClassName(String lookupResultsBOClassName)

Sets the lookupResultsBOClassName attribute value.

Parameters:

lookupResultsBOClassName - The lookupResultsBOClassName to set.

getProposalNumber

public String getProposalNumber()

setProposalNumber

public void setProposalNumber(String proposalNumber)

getMedusaBean

public MedusaBean getMedusaBean()

Gets the medusaBean attribute.

Returns:

Returns the medusaBean.

setMedusaBean

public void setMedusaBean(MedusaBean medusaBean)

Sets the medusaBean attribute value.

Parameters:

medusaBean - The medusaBean to set.

getValueFinderResultDoNotCache

public String getValueFinderResultDoNotCache()

getValueFinderResultCache

public String getValueFinderResultCache()

getReportHelperBean

public ReportHelperBean getReportHelperBean()

Specified by:

getReportHelperBean in interface ReportHelperBeanContainer

Returns:

getSelectedAwardFundingProposals

public String[] getSelectedAwardFundingProposals()

setSelectedAwardFundingProposals

public void setSelectedAwardFundingProposals(String[] selectedAwardFundingProposals)

getDisplayEditButton

public boolean getDisplayEditButton()

isCfdaLookupRequired

public boolean isCfdaLookupRequired()

getParameterService

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

getViewFundingSource

public boolean getViewFundingSource()

setViewFundingSource

public void setViewFundingSource(boolean viewFundingSource)

isDocOpenedFromIPSearch

public boolean isDocOpenedFromIPSearch()

setDocOpenedFromIPSearch

public void setDocOpenedFromIPSearch(boolean docOpened)

getHeaderNavigationTabs

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

Overrides:

getHeaderNavigationTabs in class org.kuali.rice.kns.web.struts.form.KualiForm

getExtraActionsButtons

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