org.kuali.kra.irb

Class ProtocolForm

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.irb.ProtocolForm

All Implemented Interfaces:

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

public class ProtocolForm
extends ProtocolFormBase

This class...

Author:

Kuali Nervous System Team (kualidev@oncourse.iu.edu)

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

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

DEFAULT_END, DEFAULT_MIDDLE

Constructor Summary

Constructors

Constructor and Description
ProtocolForm()

Method Summary

Methods

Modifier and Type	Method and Description
protected ActionHelperBase	createNewActionHelperInstanceHook(ProtocolFormBase protocolForm)
protected ProtocolCustomDataHelperBase	createNewCustomDataHelperInstanceHook(ProtocolFormBase protocolForm)
protected NotesAttachmentsHelperBase	createNewNotesAttachmentsHelperInstanceHook(ProtocolFormBase protocolForm)
protected OnlineReviewsActionHelperBase	createNewOnlineReviewsActionHelperInstanceHook(ProtocolFormBase protocolForm)
protected PermissionsHelperBase	createNewPermissionsHelperInstanceHook(ProtocolFormBase protocolForm)
protected PersonnelHelperBase	createNewPersonnelHelperInstanceHook(ProtocolFormBase protocolForm)
protected ProtocolHelperBase	createNewProtocolHelperInstanceHook(ProtocolFormBase protocolForm)
protected ProtocolReferenceBeanBase	createNewProtocolReferenceBeanInstance()
protected QuestionnaireHelperBase	createNewQuestionnaireHelper(ProtocolFormBase protocolForm)
protected QuestionnaireHelperBase	createNewQuestionnaireHelperInstanceHook(ProtocolFormBase protocolForm)
protected ProtocolSpecialReviewHelperBase	createNewSpecialReviewHelperInstanceHook(ProtocolFormBase protocolForm)
ActionHelper	getActionHelper()
String	getActionName()
protected String	getDefaultDocumentTypeName()
boolean	getDisplayRiskLevelPanel() This method returns true if the risk level panel should be displayed.
org.kuali.rice.kns.datadictionary.HeaderNavigation[]	getHeaderNavigationTabs()
protected String	getLockRegion()
String	getModuleCode() This method should be overriden by modules that is using person editable field.
ProtocolReferenceBean	getNewProtocolReferenceBean()
NotesAttachmentsHelper	getNotesAttachmentsHelper() Gets the Notes & Attachments Helper.
protected NotificationHelper<? extends ProtocolNotificationContextBase>	getNotificationHelperHook()
PermissionsHelper	getPermissionsHelper() Get the form's PermissionsHelper.
PersonnelHelper	getPersonnelHelper()
ProtocolDocument	getProtocolDocument()
ProtocolHelper	getProtocolHelper()
protected ProtocolOnlineReviewService	getProtocolOnlineReviewService() This method is a wrapper method for getting ProtocolOnlineReviewerService service.
protected List<String>	getTerminalNodeNamesHook()
boolean	isPropertyEditable(String propertyName)
void	populate(javax.servlet.http.HttpServletRequest request)
void	populateHeaderFields(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)

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

getActionRequests, getCustomDataHelper, getDataDictionaryService, getDeletedProtocolFundingSources, getDetailId, getExtraActionsButtons, getFormattedDate, getFormattedDateTime, getKcPersonService, getKraAuthorizationService, getLookupResultsBOClassName, getLookupResultsSequenceNumber, getMedusaBean, getNotificationHelper, getOnlineReviewsActionHelper, 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, 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

ProtocolForm

public ProtocolForm()
             throws Exception

Throws:

Exception

Method Detail

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Specified by:

getDefaultDocumentTypeName in class KraTransactionalDocumentFormBase

getHeaderNavigationTabs

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

Overrides:

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

See Also:

We only enable the Online Review tab if the protocol is in a state to be reviewed and the user has the IRB Admin role or the user has an Online Review. If HIDE_ONLINE_REVIEW_WHEN_DISABLED is true, then the tab will be removed from the tabs List if it is disabled.

getProtocolOnlineReviewService

protected ProtocolOnlineReviewService getProtocolOnlineReviewService()

This method is a wrapper method for getting ProtocolOnlineReviewerService service.

Returns:

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

getProtocolHelper

public ProtocolHelper getProtocolHelper()

Overrides:

getProtocolHelper in class ProtocolFormBase

getPersonnelHelper

public PersonnelHelper getPersonnelHelper()

Overrides:

getPersonnelHelper in class ProtocolFormBase

getPermissionsHelper

public PermissionsHelper getPermissionsHelper()

Description copied from interface: PermissionsForm

Get the form's PermissionsHelper.

Specified by:

getPermissionsHelper in interface PermissionsForm

Overrides:

getPermissionsHelper in class ProtocolFormBase

Returns:

the form's PermissionsHelper

getNewProtocolReferenceBean

public ProtocolReferenceBean getNewProtocolReferenceBean()

Overrides:

getNewProtocolReferenceBean in class ProtocolFormBase

getLockRegion

protected String getLockRegion()

Specified by:

getLockRegion in class KraTransactionalDocumentFormBase

getActionName

public String getActionName()

Overrides:

getActionName in class KraTransactionalDocumentFormBase

getNotesAttachmentsHelper

public NotesAttachmentsHelper getNotesAttachmentsHelper()

Gets the Notes & Attachments Helper.

Overrides:

getNotesAttachmentsHelper in class ProtocolFormBase

Returns:

Notes & Attachments Helper

getActionHelper

public ActionHelper getActionHelper()

Overrides:

getActionHelper in class ProtocolFormBase

getProtocolDocument

public ProtocolDocument getProtocolDocument()

Overrides:

getProtocolDocument in class ProtocolFormBase

isPropertyEditable

public boolean isPropertyEditable(String propertyName)

Overrides:

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

getDisplayRiskLevelPanel

public boolean getDisplayRiskLevelPanel()

This method returns true if the risk level panel should be displayed.

Returns:

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:

getNotificationHelperHook

protected NotificationHelper<? extends ProtocolNotificationContextBase> getNotificationHelperHook()

Specified by:

getNotificationHelperHook in class ProtocolFormBase

createNewProtocolReferenceBeanInstance

protected ProtocolReferenceBeanBase createNewProtocolReferenceBeanInstance()

Specified by:

createNewProtocolReferenceBeanInstance in class ProtocolFormBase

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

createNewProtocolHelperInstanceHook

protected ProtocolHelperBase createNewProtocolHelperInstanceHook(ProtocolFormBase protocolForm)

Specified by:

createNewProtocolHelperInstanceHook in class ProtocolFormBase

createNewPermissionsHelperInstanceHook

protected PermissionsHelperBase createNewPermissionsHelperInstanceHook(ProtocolFormBase protocolForm)

Specified by:

createNewPermissionsHelperInstanceHook in class ProtocolFormBase

createNewPersonnelHelperInstanceHook

protected PersonnelHelperBase createNewPersonnelHelperInstanceHook(ProtocolFormBase protocolForm)

Specified by:

createNewPersonnelHelperInstanceHook in class ProtocolFormBase

createNewQuestionnaireHelper

protected QuestionnaireHelperBase createNewQuestionnaireHelper(ProtocolFormBase protocolForm)

Specified by:

createNewQuestionnaireHelper in class ProtocolFormBase

createNewNotesAttachmentsHelperInstanceHook

protected NotesAttachmentsHelperBase createNewNotesAttachmentsHelperInstanceHook(ProtocolFormBase protocolForm)

Specified by:

createNewNotesAttachmentsHelperInstanceHook in class ProtocolFormBase

getTerminalNodeNamesHook

protected List<String> getTerminalNodeNamesHook()

Specified by:

getTerminalNodeNamesHook in class ProtocolFormBase