org.kuali.kra.common.committee.web.struts.form

Class CommitteeFormBase

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.common.committee.web.struts.form.CommitteeFormBase

All Implemented Interfaces:

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

Direct Known Subclasses:

CommitteeForm, IacucCommitteeForm

public abstract class CommitteeFormBase
extends KraTransactionalDocumentFormBase

The CommitteeBase Form contains the fields necessary for all POST operations coming from a web browser pertaining to the editing of a CommitteeBase. The form contains a reference to the original committee document. User requests will result in the document fields being set. It is the responsibility of the business rules to validate the new values of those fields. The CommitteeBase Form has Helpers for some tabs (web pages), if necessary. For extra properties, e.g. fields for adding a new entry to a table, those properties reside in the Helper corresponding to the tab (web page) they are associated with.

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

Method Summary

Methods

Modifier and Type	Method and Description
CommitteeDocumentBase	getCommitteeDocument() Get the CommitteeBase Document.
CommitteeHelperBase	getCommitteeHelper()
protected String	getCommitteeNameForHeaderDisplay(CommitteeDocumentBase committeeDoc)
protected abstract String	getDefaultDocumentTypeName()
org.kuali.rice.kns.datadictionary.HeaderNavigation[]	getHeaderNavigationTabs() We need to remove the "Actions" tab when the committee is in edit mode, as actions are only supposed to be taken by the admin when viewing.
protected String	getLockRegion()
String	getLookupResultsBOClassName() Get the Lookup Results BO Classname
String	getLookupResultsSequenceNumber() Get the Lookup Results Sequence Number.
protected abstract CommitteeHelperBase	getNewCommitteeHelperInstanceHook(CommitteeFormBase commonCommitteeForm)
void	initialize() This method initialize all form variables
boolean	isPropertyEditable(String propertyName) Without this hack, a committee member that is inactive and has a validation error can't be edited in the Active Members only display mode.
void	populate(javax.servlet.http.HttpServletRequest request) o
void	populateHeaderFields(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)
void	reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
void	setCommitteeHelper(CommitteeHelperBase committeeHelper)
void	setLookupResultsBOClassName(String lookupResultsBOClassName) Set the Lookup Results BO Classname
void	setLookupResultsSequenceNumber(String lookupResultsSequenceNumber) Set the Lookup Results Sequence Number.
protected void	setSaveDocumentControl(Map editMode)

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

CommitteeFormBase

public CommitteeFormBase()

Constructs a CommitteeFormBase.

Method Detail

getDefaultDocumentTypeName

protected abstract String getDefaultDocumentTypeName()

Specified by:

getDefaultDocumentTypeName in class KraTransactionalDocumentFormBase

initialize

public void initialize()

This method initialize all form variables

getNewCommitteeHelperInstanceHook

protected abstract CommitteeHelperBase getNewCommitteeHelperInstanceHook(CommitteeFormBase commonCommitteeForm)

getCommitteeDocument

public CommitteeDocumentBase getCommitteeDocument()

Get the CommitteeBase Document.

Returns:

the committee document

populate

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

o

Specified by:

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

Overrides:

populate in class KraTransactionalDocumentFormBase

See Also:

org.kuali.core.web.struts.form.KualiDocumentFormBase#populate(javax.servlet.http.HttpServletRequest)

getCommitteeNameForHeaderDisplay

protected String getCommitteeNameForHeaderDisplay(CommitteeDocumentBase committeeDoc)

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:

org.kuali.core.web.struts.form.KualiDocumentFormBase#populateHeaderFields(org.kuali.core.workflow.service.KualiWorkflowDocument)

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
         javax.servlet.http.HttpServletRequest request)

Overrides:

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

See Also:

KualiDocumentFormBase.reset(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)

getLookupResultsSequenceNumber

public String getLookupResultsSequenceNumber()

Get the Lookup Results Sequence Number.

Returns:

the lookup results sequence number

setLookupResultsSequenceNumber

public void setLookupResultsSequenceNumber(String lookupResultsSequenceNumber)

Set the Lookup Results Sequence Number.

Parameters:

lookupResultsSequenceNumber - the lookup results sequence number

getLookupResultsBOClassName

public String getLookupResultsBOClassName()

Get the Lookup Results BO Classname

Returns:

the lookup results BO classname

setLookupResultsBOClassName

public void setLookupResultsBOClassName(String lookupResultsBOClassName)

Set the Lookup Results BO Classname

Parameters:

lookupResultsBOClassName - the lookup results BO classname

setSaveDocumentControl

protected void setSaveDocumentControl(Map editMode)

Specified by:

setSaveDocumentControl in class KraTransactionalDocumentFormBase

See Also:

org.kuali.kra.web.struts.form.KraTransactionalDocumentFormBase#setSaveDocumentControl(org.kuali.core.document.authorization.DocumentActionFlags, java.util.Map)

getLockRegion

protected String getLockRegion()

Specified by:

getLockRegion in class KraTransactionalDocumentFormBase

See Also:

KraTransactionalDocumentFormBase.getLockRegion()

getCommitteeHelper

public CommitteeHelperBase getCommitteeHelper()

setCommitteeHelper

public void setCommitteeHelper(CommitteeHelperBase committeeHelper)

isPropertyEditable

public boolean isPropertyEditable(String propertyName)

Without this hack, a committee member that is inactive and has a validation error can't be edited in the Active Members only display mode.

Overrides:

isPropertyEditable in class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

See Also:

PojoFormBase.isPropertyEditable(java.lang.String)

getHeaderNavigationTabs

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

We need to remove the "Actions" tab when the committee is in edit mode, as actions are only supposed to be taken by the admin when viewing.

Overrides:

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

See Also:

KualiForm.getHeaderNavigationTabs()