org.kuali.kra.iacuc

Class IacucProtocolForm

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.protocol.ProtocolFormBase

org.kuali.kra.iacuc.IacucProtocolForm

All Implemented Interfaces:

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

public class IacucProtocolForm
extends ProtocolFormBase

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.protocol.ProtocolFormBase

CUSTOM_DATA_NAV_TO, HIDE_ONLINE_REVIEW_WHEN_DISABLED, ONLINE_REVIEW_NAV_TO

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

Fields inherited from interface org.kuali.kra.questionnaire.QuestionableFormInterface

DEFAULT_END, DEFAULT_MIDDLE

Constructor Summary

Constructors

Constructor and Description
IacucProtocolForm()

Method Summary

Methods

Modifier and Type	Method and Description
protected IacucActionHelper	createNewActionHelper(ProtocolFormBase protocolForm)
protected ActionHelperBase	createNewActionHelperInstanceHook(ProtocolFormBase protocolForm)
protected ProtocolCustomDataHelperBase	createNewCustomDataHelperInstanceHook(ProtocolFormBase protocolForm)
protected IacucNotesAttachmentsHelper	createNewNotesAttachmentsHelperInstanceHook(ProtocolFormBase protocolForm)
protected OnlineReviewsActionHelperBase	createNewOnlineReviewsActionHelperInstanceHook(ProtocolFormBase protocolForm)
protected IacucPermissionsHelper	createNewPermissionsHelperInstanceHook(ProtocolFormBase protocolForm)
protected IacucPersonnelHelper	createNewPersonnelHelperInstanceHook(ProtocolFormBase protocolForm)
protected ProtocolHelperBase	createNewProtocolHelperInstanceHook(ProtocolFormBase protocolForm)
protected ProtocolReferenceBeanBase	createNewProtocolReferenceBeanInstance()
protected QuestionnaireHelperBase	createNewQuestionnaireHelper(ProtocolFormBase form)
protected QuestionnaireHelperBase	createNewQuestionnaireHelperInstanceHook(ProtocolFormBase protocolForm)
protected ProtocolSpecialReviewHelperBase	createNewSpecialReviewHelperInstanceHook(ProtocolFormBase protocolForm)
String	getActionName()
protected String	getDefaultDocumentTypeName()
org.kuali.rice.kns.datadictionary.HeaderNavigation[]	getHeaderNavigationTabs()
IacucAlternateSearchHelper	getIacucAlternateSearchHelper()
IacucProtocolDocument	getIacucProtocolDocument() Gets a ProtocolDocument.
IacucProtocolExceptionHelper	getIacucProtocolExceptionHelper()
protected IacucProtocolProcedureService	getIacucProtocolProcedureService()
IacucProtocolProceduresHelper	getIacucProtocolProceduresHelper()
IacucProtocolSpeciesHelper	getIacucProtocolSpeciesHelper()
protected String	getLockRegion()
String	getModuleCode() This method should be overriden by modules that is using person editable field.
IacucNotesAttachmentsHelper	getNotesAttachmentHelper(ProtocolFormBase form)
protected NotificationHelper<IacucProtocolNotificationContext>	getNotificationHelperHook()
IacucPermissionsHelper	getPermissionsHelper(ProtocolFormBase protocolForm)
IacucPersonnelHelper	getPersonnelHelper(ProtocolFormBase protocolForm)
IacucProtocolHelper	getProtocolHelper()
protected ProtocolOnlineReviewService	getProtocolOnlineReviewService()
protected List<String>	getTerminalNodeNamesHook()
protected void	initializeIacucAlternateSearchHelper()
void	initializeIacucProtocolException()
void	initializeIacucProtocolProcedures()
void	initializeIacucProtocolSpecies()
boolean	isDefaultOpenCopyTab()
boolean	isReinitializeModifySubmissionFields()
void	populate(javax.servlet.http.HttpServletRequest request)
void	populateHeaderFields(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)
void	setDefaultOpenCopyTab(boolean defaultOpenCopyTab)
void	setIacucAlternateSearchHelper(IacucAlternateSearchHelper iacucAlternateSearchHelper)
void	setIacucProtocolExceptionHelper(IacucProtocolExceptionHelper iacucProtocolExceptionHelper)
void	setIacucProtocolProceduresHelper(IacucProtocolProceduresHelper iacucProtocolProceduresHelper)
void	setIacucProtocolSpeciesHelper(IacucProtocolSpeciesHelper iacucProtocolSpeciesHelper)
void	setReinitializeModifySubmissionFields(boolean reinitializeModifySubmissionFields)

Methods inherited from class org.kuali.kra.protocol.ProtocolFormBase

getActionHelper, getActionRequests, getCustomDataHelper, getDataDictionaryService, getDeletedProtocolFundingSources, getDetailId, getExtraActionsButtons, getFormattedDate, getFormattedDateTime, getKcPersonService, getKraAuthorizationService, getLookupResultsBOClassName, getLookupResultsSequenceNumber, getMedusaBean, getNewProtocolReferenceBean, getNotesAttachmentsHelper, getNotificationHelper, getOnlineReviewsActionHelper, getPermissionsHelper, getPersonnelHelper, getProtocolDocument, getQuestionnaireExpression, getQuestionnaireFieldEnd, getQuestionnaireFieldMiddle, getQuestionnaireFieldStarter, getQuestionnaireHelper, getSpecialReviewHelper, initialize, isAuditActivated, isJavaScriptEnabled, isShowNotificationEditor, isSuperUserActionAvaliable, isSuperUserApproveDocumentAuthorized, reset, setActionHelper, setAuditActivated, setCustomDataHelper, setDeletedProtocolFundingSources, setDetailId, setJavaScriptEnabled, setLookupResultsBOClassName, setLookupResultsSequenceNumber, setMedusaBean, setNewProtocolReferenceBean, setNotesAttachmentsHelper, setNotificationHelper, setOnlineReviewsActionHelper, setProtocolHelper, setQuestionnaireHelper, setSaveDocumentControl, setShowNotificationEditor, setSpecialReviewHelper

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

addExtraButton, clearUnitRulesMessages, getHeaderDispatch, 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, 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, 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, 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

Constructor Detail

IacucProtocolForm

public IacucProtocolForm()
                  throws Exception

Throws:

Exception

Method Detail

initializeIacucProtocolSpecies

public void initializeIacucProtocolSpecies()
                                    throws Exception

Throws:

Exception

initializeIacucProtocolProcedures

public void initializeIacucProtocolProcedures()
                                       throws Exception

Throws:

Exception

initializeIacucProtocolException

public void initializeIacucProtocolException()
                                      throws Exception

Throws:

Exception

initializeIacucAlternateSearchHelper

protected void initializeIacucAlternateSearchHelper()
                                             throws Exception

Throws:

Exception

getActionName

public String getActionName()

Overrides:

getActionName in class KraTransactionalDocumentFormBase

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Specified by:

getDefaultDocumentTypeName in class KraTransactionalDocumentFormBase

getIacucProtocolDocument

public IacucProtocolDocument getIacucProtocolDocument()

Gets a ProtocolDocument.

Returns:

ProtocolDocument

getLockRegion

protected String getLockRegion()

Specified by:

getLockRegion in class KraTransactionalDocumentFormBase

getProtocolHelper

public IacucProtocolHelper getProtocolHelper()

Overrides:

getProtocolHelper in class ProtocolFormBase

createNewProtocolHelperInstanceHook

protected ProtocolHelperBase createNewProtocolHelperInstanceHook(ProtocolFormBase protocolForm)

Specified by:

createNewProtocolHelperInstanceHook in class ProtocolFormBase

getPermissionsHelper

public IacucPermissionsHelper getPermissionsHelper(ProtocolFormBase protocolForm)

createNewPermissionsHelperInstanceHook

protected IacucPermissionsHelper createNewPermissionsHelperInstanceHook(ProtocolFormBase protocolForm)

Specified by:

createNewPermissionsHelperInstanceHook in class ProtocolFormBase

getPersonnelHelper

public IacucPersonnelHelper getPersonnelHelper(ProtocolFormBase protocolForm)

createNewPersonnelHelperInstanceHook

protected IacucPersonnelHelper createNewPersonnelHelperInstanceHook(ProtocolFormBase protocolForm)

Specified by:

createNewPersonnelHelperInstanceHook in class ProtocolFormBase

getNotesAttachmentHelper

public IacucNotesAttachmentsHelper getNotesAttachmentHelper(ProtocolFormBase form)

createNewNotesAttachmentsHelperInstanceHook

protected IacucNotesAttachmentsHelper createNewNotesAttachmentsHelperInstanceHook(ProtocolFormBase protocolForm)

Specified by:

createNewNotesAttachmentsHelperInstanceHook in class ProtocolFormBase

createNewQuestionnaireHelper

protected QuestionnaireHelperBase createNewQuestionnaireHelper(ProtocolFormBase form)

Specified by:

createNewQuestionnaireHelper in class ProtocolFormBase

createNewActionHelper

protected IacucActionHelper createNewActionHelper(ProtocolFormBase protocolForm)
                                           throws Exception

Throws:

Exception

getModuleCode

public String getModuleCode()

Description copied from class: KraTransactionalDocumentFormBase

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

Specified by:

getModuleCode in class ProtocolFormBase

Returns:

getIacucProtocolSpeciesHelper

public IacucProtocolSpeciesHelper getIacucProtocolSpeciesHelper()

setIacucProtocolSpeciesHelper

public void setIacucProtocolSpeciesHelper(IacucProtocolSpeciesHelper iacucProtocolSpeciesHelper)

getIacucAlternateSearchHelper

public IacucAlternateSearchHelper getIacucAlternateSearchHelper()

setIacucAlternateSearchHelper

public void setIacucAlternateSearchHelper(IacucAlternateSearchHelper iacucAlternateSearchHelper)

createNewProtocolReferenceBeanInstance

protected ProtocolReferenceBeanBase createNewProtocolReferenceBeanInstance()

Specified by:

createNewProtocolReferenceBeanInstance in class ProtocolFormBase

getIacucProtocolExceptionHelper

public IacucProtocolExceptionHelper getIacucProtocolExceptionHelper()

setIacucProtocolExceptionHelper

public void setIacucProtocolExceptionHelper(IacucProtocolExceptionHelper iacucProtocolExceptionHelper)

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 KraTransactionalDocumentFormBase

populateHeaderFields

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

Overrides:

populateHeaderFields in class ProtocolFormBase

getHeaderNavigationTabs

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

Overrides:

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

getProtocolOnlineReviewService

protected ProtocolOnlineReviewService getProtocolOnlineReviewService()

createNewQuestionnaireHelperInstanceHook

protected QuestionnaireHelperBase createNewQuestionnaireHelperInstanceHook(ProtocolFormBase protocolForm)

Specified by:

createNewQuestionnaireHelperInstanceHook in class ProtocolFormBase

createNewActionHelperInstanceHook

protected ActionHelperBase createNewActionHelperInstanceHook(ProtocolFormBase protocolForm)
                                                      throws Exception

Specified by:

createNewActionHelperInstanceHook in class ProtocolFormBase

Throws:

Exception

createNewSpecialReviewHelperInstanceHook

protected ProtocolSpecialReviewHelperBase createNewSpecialReviewHelperInstanceHook(ProtocolFormBase protocolForm)

Specified by:

createNewSpecialReviewHelperInstanceHook in class ProtocolFormBase

createNewCustomDataHelperInstanceHook

protected ProtocolCustomDataHelperBase createNewCustomDataHelperInstanceHook(ProtocolFormBase protocolForm)

Specified by:

createNewCustomDataHelperInstanceHook in class ProtocolFormBase

createNewOnlineReviewsActionHelperInstanceHook

protected OnlineReviewsActionHelperBase createNewOnlineReviewsActionHelperInstanceHook(ProtocolFormBase protocolForm)

Specified by:

createNewOnlineReviewsActionHelperInstanceHook in class ProtocolFormBase

getIacucProtocolProceduresHelper

public IacucProtocolProceduresHelper getIacucProtocolProceduresHelper()

setIacucProtocolProceduresHelper

public void setIacucProtocolProceduresHelper(IacucProtocolProceduresHelper iacucProtocolProceduresHelper)

getNotificationHelperHook

protected NotificationHelper<IacucProtocolNotificationContext> getNotificationHelperHook()

Specified by:

getNotificationHelperHook in class ProtocolFormBase

getIacucProtocolProcedureService

protected IacucProtocolProcedureService getIacucProtocolProcedureService()

isReinitializeModifySubmissionFields

public boolean isReinitializeModifySubmissionFields()

setReinitializeModifySubmissionFields

public void setReinitializeModifySubmissionFields(boolean reinitializeModifySubmissionFields)

isDefaultOpenCopyTab

public boolean isDefaultOpenCopyTab()

setDefaultOpenCopyTab

public void setDefaultOpenCopyTab(boolean defaultOpenCopyTab)

getTerminalNodeNamesHook

protected List<String> getTerminalNodeNamesHook()

Specified by:

getTerminalNodeNamesHook in class ProtocolFormBase