org.kuali.kra.subaward

Class SubAwardForm

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.subaward.SubAwardForm

All Implemented Interfaces:

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

public class SubAwardForm
extends KraTransactionalDocumentFormBase
implements PermissionsForm, Auditable, CustomDataDocumentForm

This class represents the SubAward Form Struts 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

Modifier and Type	Field and Description
static String	COLUMN

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
SubAwardForm() Constructs a SubAwardForm.java.

Method Summary

Methods

Modifier and Type	Method and Description
CustomDataHelper	getCustomDataHelper() .
protected String	getDefaultDocumentTypeName()
int	getDefaultFollowUpDayDifference() .
boolean	getDisplayEditButton()
String	getDocumentTypeName() .
List<org.kuali.rice.kns.web.ui.ExtraButton>	getExtraFinancialButtons()
protected String	getLockRegion()
String	getLookupResultsBOClassName()
String	getLookupResultsSequenceNumber()
MedusaBean	getMedusaBean() Gets the medusaBean attribute.
org.apache.struts.upload.FormFile	getNewFile() .
SubAwardAmountInfo	getNewSubAwardAmountInfo() .
SubAwardAmountReleased	getNewSubAwardAmountReleased() .
SubAwardCloseout	getNewSubAwardCloseout()
SubAwardContact	getNewSubAwardContact()
SubAwardFundingSource	getNewSubAwardFundingSource() .
NotificationHelper<SubAwardNotificationContext>	getNotificationHelper()
PermissionsHelperBase	getPermissionsHelper() Get the form's PermissionsHelper.
SubAward	getSubAward()
SubAwardDocument	getSubAwardDocument() This method returns the SubAwardDocument object.
protected VersionHistoryService	getVersionHistoryService()
void	initialize() .
void	initializeFormOrDocumentBasedOnCommand() This method initializes either the document or the form based on the command value.
boolean	isAuditActivated() .
void	populateHeaderFields(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)
void	setAuditActivated(boolean auditActivated) .
void	setCustomDataHelper(CustomDataHelper customDataHelper) .
void	setLookupResultsBOClassName(String lookupResultsBOClassName)
void	setLookupResultsSequenceNumber(String lookupResultsSequenceNumber)
void	setMedusaBean(MedusaBean medusaBean) Sets the medusaBean attribute value.
void	setNewFile(org.apache.struts.upload.FormFile newFile) .
void	setNewSubAwardAmountInfo(SubAwardAmountInfo newSubAwardAmountInfo) .
void	setNewSubAwardAmountReleased(SubAwardAmountReleased newSubAwardAmountReleased) .
void	setNewSubAwardCloseout(SubAwardCloseout newSubAwardCloseout)
void	setNewSubAwardContact(SubAwardContact newSubAwardContact)
void	setNewSubAwardFundingSource(SubAwardFundingSource newSubAwardFundingSource) .
void	setNotificationHelper(NotificationHelper<SubAwardNotificationContext> notificationHelper)
protected void	setSaveDocumentControl(Map editMode)
void	setSubAward(SubAward subAward)

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

addExtraButton, clearUnitRulesMessages, getActionName, 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, 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, getHeaderNavigationTabs, 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.common.permissions.web.struts.form.PermissionsForm

getDocument

Field Detail

COLUMN

public static final String COLUMN

See Also:

Constant Field Values

Constructor Detail

SubAwardForm

public SubAwardForm()

Constructs a SubAwardForm.java.

Method Detail

getNewFile

public org.apache.struts.upload.FormFile getNewFile()

. This is the Getter Method for newFile

Returns:

Returns the newFile.

setNewFile

public void setNewFile(org.apache.struts.upload.FormFile newFile)

. This is the Setter Method for newFile

Parameters:

newFile - The newFile to set.

isAuditActivated

public boolean isAuditActivated()

. This is the Getter Method for auditActivated

Specified by:

isAuditActivated in interface Auditable

Returns:

Returns the auditActivated.

setAuditActivated

public void setAuditActivated(boolean auditActivated)

. This is the Setter Method for auditActivated

Specified by:

setAuditActivated in interface Auditable

Parameters:

auditActivated - The auditActivated to set.

getNewSubAwardFundingSource

public SubAwardFundingSource getNewSubAwardFundingSource()

. This is the Getter Method for newSubAwardFundingSource

Returns:

Returns the newSubAwardFundingSource.

setNewSubAwardFundingSource

public void setNewSubAwardFundingSource(SubAwardFundingSource newSubAwardFundingSource)

. This is the Setter Method for newSubAwardFundingSource

Parameters:

newSubAwardFundingSource - The newSubAwardFundingSource to set.

getNewSubAwardAmountInfo

public SubAwardAmountInfo getNewSubAwardAmountInfo()

. This is the Getter Method for newSubAwardAmountInfo

Returns:

Returns the newSubAwardAmountInfo.

setNewSubAwardAmountInfo

public void setNewSubAwardAmountInfo(SubAwardAmountInfo newSubAwardAmountInfo)

. This is the Setter Method for newSubAwardAmountInfo

Parameters:

newSubAwardAmountInfo - The newSubAwardAmountInfo to set.

getNewSubAwardAmountReleased

public SubAwardAmountReleased getNewSubAwardAmountReleased()

. This is the Getter Method for newSubAwardAmountReleased

Returns:

Returns the newSubAwardAmountReleased.

setNewSubAwardAmountReleased

public void setNewSubAwardAmountReleased(SubAwardAmountReleased newSubAwardAmountReleased)

. This is the Setter Method for newSubAwardAmountReleased

Parameters:

newSubAwardAmountReleased - The newSubAwardAmountReleased to set.

getCustomDataHelper

public CustomDataHelper getCustomDataHelper()

. This is the Getter Method for customDataHelper

Specified by:

getCustomDataHelper in interface CustomDataDocumentForm

Returns:

Returns the customDataHelper.

setCustomDataHelper

public void setCustomDataHelper(CustomDataHelper customDataHelper)

. This is the Setter Method for customDataHelper

Parameters:

customDataHelper - The customDataHelper to set.

getNotificationHelper

public NotificationHelper<SubAwardNotificationContext> getNotificationHelper()

setNotificationHelper

public void setNotificationHelper(NotificationHelper<SubAwardNotificationContext> notificationHelper)

setSubAward

public void setSubAward(SubAward subAward)

initialize

public void initialize()

. This method initialize all form variables

getSubAwardDocument

public SubAwardDocument getSubAwardDocument()

This method returns the SubAwardDocument object.

Returns:

SubAwardDocument

getDocumentTypeName

public String getDocumentTypeName()

. This method returns a string representation of the document type

Returns:

SubAwardDocument

populateHeaderFields

public void populateHeaderFields(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)

Overrides:

populateHeaderFields in class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

See Also:

KualiDocumentFormBase#populateHeaderFields( org.kuali.rice.kew.api.WorkflowDocument)

initializeFormOrDocumentBasedOnCommand

public void initializeFormOrDocumentBasedOnCommand()

This method initializes either the document or the form based on the command value.

getLockRegion

protected String getLockRegion()

Specified by:

getLockRegion in class KraTransactionalDocumentFormBase

setSaveDocumentControl

protected void setSaveDocumentControl(Map editMode)

Specified by:

setSaveDocumentControl in class KraTransactionalDocumentFormBase

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Description copied from class: KraTransactionalDocumentFormBase

Specified by:

getDefaultDocumentTypeName in class KraTransactionalDocumentFormBase

getSubAward

public SubAward getSubAward()

setLookupResultsSequenceNumber

public void setLookupResultsSequenceNumber(String lookupResultsSequenceNumber)

getLookupResultsSequenceNumber

public String getLookupResultsSequenceNumber()

setLookupResultsBOClassName

public void setLookupResultsBOClassName(String lookupResultsBOClassName)

getLookupResultsBOClassName

public String getLookupResultsBOClassName()

getPermissionsHelper

public PermissionsHelperBase getPermissionsHelper()

Description copied from interface: PermissionsForm

Get the form's PermissionsHelper.

Specified by:

getPermissionsHelper in interface PermissionsForm

Returns:

the form's PermissionsHelper

setNewSubAwardCloseout

public void setNewSubAwardCloseout(SubAwardCloseout newSubAwardCloseout)

getNewSubAwardCloseout

public SubAwardCloseout getNewSubAwardCloseout()

setNewSubAwardContact

public void setNewSubAwardContact(SubAwardContact newSubAwardContact)

getNewSubAwardContact

public SubAwardContact getNewSubAwardContact()

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.

getDefaultFollowUpDayDifference

public int getDefaultFollowUpDayDifference()

. This returns the value of subawardservice. getFollowupDateDefaultLengthInDays() to be used on subAwardCloseout.tag

Returns:

getExtraFinancialButtons

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

getDisplayEditButton

public boolean getDisplayEditButton()

getVersionHistoryService

protected VersionHistoryService getVersionHistoryService()