org.kuali.kra.web.struts.form

Class KraTransactionalDocumentFormBase

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BudgetVersionFormBase, CoiDisclosureForm, CommitteeFormBase, InstitutionalProposalForm, NegotiationForm, PersonMassChangeForm, ProtocolFormBase, ProtocolOnlineReviewFormBase, SubAwardForm, TimeAndMoneyForm

public abstract class KraTransactionalDocumentFormBase
extends org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

This class isbase class for KC Transactional Documents ...

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
protected String	actionName
protected String	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
KraTransactionalDocumentFormBase()

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.
void	clearUnitRulesMessages()
String	getActionName()
protected abstract String	getDefaultDocumentTypeName()
String	getHeaderDispatch() Get the Header Dispatch.
protected abstract String	getLockRegion()
String	getModuleCode() This method should be overriden by modules that is using person editable field.
String	getNavigateTo()
Map<String,Boolean>	getPersonEditableFields()
Map<String,Collection<SoftError>>	getSoftErrors() Consume SoftErrors (if any) and return the collection
List<String>	getUnitRulesErrors()
List<String>	getUnitRulesMessages()
protected List<String>	getUnitRulesMessages(String messageType)
List<String>	getUnitRulesWarnings()
protected boolean	hasModifyBudgetPermission(Map editMode)
protected boolean	hasModifyCompletedBudgetPermission(Map editMode)
protected boolean	hasModifyNarrativesPermission(Map editMode)
protected boolean	hasModifyProposalPermission(Map editMode)
boolean	isMedusaOpenedDoc()
boolean	isPopupViewOnly()
boolean	isUnitRulesErrorsExist()
boolean	isUnitRulesWarningsExist()
boolean	isViewOnly()
void	populate(javax.servlet.http.HttpServletRequest request)
protected void	populateFalseCheckboxes(javax.servlet.http.HttpServletRequest request) This is a duplication of KualiTransactionalDocumentFormBase.populateFalseCheckboxes with the cavet that this function puts a NULL in for fields that contain "answer", which are the field names of radio Y/N buttons for the questionnaire framework.
void	populatePersonEditableFields() Creates the list of PersonEditableField field names.
protected void	processMultiQuestionCheckBox(String propertyName, Map<String,String[]> parameterMap, MultiQuestionableFormInterface form)
void	setActionName(String actionName)
void	setDocument(org.kuali.rice.krad.document.Document document)
void	setMedusaOpenedDoc(boolean medusaOpenedDoc)
void	setNavigateTo(String navigateTo)
void	setPersonEditableFields(Map<String,Boolean> personEditableFields)
void	setPopupViewOnly(boolean popupViewOnly)
protected abstract void	setSaveDocumentControl(Map editMode)
void	setUnitRulesMessages(List<String> unitRulesMessages)
void	setupLockRegions()
void	setViewOnly(boolean viewOnly)

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

Field Detail

actionName

protected String actionName

navigateTo

protected String navigateTo

Constructor Detail

KraTransactionalDocumentFormBase

public KraTransactionalDocumentFormBase()

Method Detail

getActionName

public String getActionName()

setActionName

public void setActionName(String actionName)

getNavigateTo

public String getNavigateTo()

setNavigateTo

public void setNavigateTo(String navigateTo)

populate

public void populate(javax.servlet.http.HttpServletRequest request)

Specified by:

populate in interface org.kuali.rice.kns.web.struts.form.pojo.PojoForm

Overrides:

populate in class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

getSoftErrors

public Map<String,Collection<SoftError>> getSoftErrors()

Consume SoftErrors (if any) and return the collection

Returns:

setupLockRegions

public void setupLockRegions()

hasModifyProposalPermission

protected boolean hasModifyProposalPermission(Map editMode)

hasModifyBudgetPermission

protected boolean hasModifyBudgetPermission(Map editMode)

hasModifyCompletedBudgetPermission

protected boolean hasModifyCompletedBudgetPermission(Map editMode)

hasModifyNarrativesPermission

protected boolean hasModifyNarrativesPermission(Map editMode)

getHeaderDispatch

public String getHeaderDispatch()

Get the Header Dispatch. This determines the action that will occur when the user switches tabs for a document. If the user can modify the document, the document is automatically saved. If not (view-only), then a reload will be executed instead.

Returns:

the Header Dispatch action

getLockRegion

protected abstract String getLockRegion()

setSaveDocumentControl

protected abstract void setSaveDocumentControl(Map editMode)

isViewOnly

public final boolean isViewOnly()

setViewOnly

public final void setViewOnly(boolean viewOnly)

isPopupViewOnly

public final boolean isPopupViewOnly()

setPopupViewOnly

public final void setPopupViewOnly(boolean popupViewOnly)

setDocument

public void setDocument(org.kuali.rice.krad.document.Document document)

Overrides:

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

getDefaultDocumentTypeName

protected abstract String getDefaultDocumentTypeName()

Overrides:

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

isMedusaOpenedDoc

public boolean isMedusaOpenedDoc()

setMedusaOpenedDoc

public void setMedusaOpenedDoc(boolean medusaOpenedDoc)

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.

Parameters:

property -

source -

altText -

getPersonEditableFields

public Map<String,Boolean> getPersonEditableFields()

setPersonEditableFields

public void setPersonEditableFields(Map<String,Boolean> personEditableFields)

populatePersonEditableFields

public void populatePersonEditableFields()

Creates the list of PersonEditableField field names.

getModuleCode

public String getModuleCode()

This method should be overriden by modules that is using person editable field.

Returns:

populateFalseCheckboxes

protected void populateFalseCheckboxes(javax.servlet.http.HttpServletRequest request)

This is a duplication of KualiTransactionalDocumentFormBase.populateFalseCheckboxes with the cavet that this function puts a NULL in for fields that contain "answer", which are the field names of radio Y/N buttons for the questionnaire framework.

Overrides:

populateFalseCheckboxes in class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

See Also:

KualiTransactionalDocumentFormBase.populateFalseCheckboxes(javax.servlet.http.HttpServletRequest)

processMultiQuestionCheckBox

protected void processMultiQuestionCheckBox(String propertyName,
                                Map<String,String[]> parameterMap,
                                MultiQuestionableFormInterface form)

getUnitRulesMessages

public List<String> getUnitRulesMessages()

setUnitRulesMessages

public void setUnitRulesMessages(List<String> unitRulesMessages)

isUnitRulesErrorsExist

public boolean isUnitRulesErrorsExist()

isUnitRulesWarningsExist

public boolean isUnitRulesWarningsExist()

getUnitRulesErrors

public List<String> getUnitRulesErrors()

getUnitRulesWarnings

public List<String> getUnitRulesWarnings()

clearUnitRulesMessages

public void clearUnitRulesMessages()

getUnitRulesMessages

protected List<String> getUnitRulesMessages(String messageType)