org.kuali.kra.protocol

Class ProtocolFormBase

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

All Implemented Interfaces:

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

Direct Known Subclasses:

IacucProtocolForm, ProtocolForm

public abstract class ProtocolFormBase
extends KraTransactionalDocumentFormBase
implements PermissionsForm, Auditable, QuestionableFormInterface, CustomDataDocumentForm

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

Modifier and Type	Field and Description
protected static String	CUSTOM_DATA_NAV_TO
protected static boolean	HIDE_ONLINE_REVIEW_WHEN_DISABLED
protected static String	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
ProtocolFormBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract ActionHelperBase	createNewActionHelperInstanceHook(ProtocolFormBase protocolForm)
protected abstract ProtocolCustomDataHelperBase	createNewCustomDataHelperInstanceHook(ProtocolFormBase protocolForm)
protected abstract NotesAttachmentsHelperBase	createNewNotesAttachmentsHelperInstanceHook(ProtocolFormBase protocolForm)
protected abstract OnlineReviewsActionHelperBase	createNewOnlineReviewsActionHelperInstanceHook(ProtocolFormBase protocolForm)
protected abstract PermissionsHelperBase	createNewPermissionsHelperInstanceHook(ProtocolFormBase protocolForm)
protected abstract PersonnelHelperBase	createNewPersonnelHelperInstanceHook(ProtocolFormBase protocolForm)
protected abstract ProtocolHelperBase	createNewProtocolHelperInstanceHook(ProtocolFormBase protocolForm)
protected abstract ProtocolReferenceBeanBase	createNewProtocolReferenceBeanInstance()
protected abstract QuestionnaireHelperBase	createNewQuestionnaireHelper(ProtocolFormBase protocolForm)
protected abstract QuestionnaireHelperBase	createNewQuestionnaireHelperInstanceHook(ProtocolFormBase protocolForm)
protected abstract ProtocolSpecialReviewHelperBase	createNewSpecialReviewHelperInstanceHook(ProtocolFormBase protocolForm)
ActionHelperBase	getActionHelper()
List<org.kuali.rice.kew.api.action.ActionRequest>	getActionRequests()
ProtocolCustomDataHelperBase	getCustomDataHelper()
protected org.kuali.rice.kns.service.DataDictionaryService	getDataDictionaryService() This method is a wrapper method for getting DataDictionary Service using the Service Locator.
List<ProtocolFundingSourceBase>	getDeletedProtocolFundingSources()
String	getDetailId()
List<org.kuali.rice.kns.web.ui.ExtraButton>	getExtraActionsButtons()
protected String	getFormattedDate(Date dateInput)
protected String	getFormattedDateTime(Timestamp dateTimeInput)
protected KcPersonService	getKcPersonService()
KraAuthorizationService	getKraAuthorizationService()
String	getLookupResultsBOClassName()
String	getLookupResultsSequenceNumber()
MedusaBean	getMedusaBean()
abstract String	getModuleCode() This method should be overriden by modules that is using person editable field.
ProtocolReferenceBeanBase	getNewProtocolReferenceBean()
NotesAttachmentsHelperBase	getNotesAttachmentsHelper() Gets the Notes & Attachments Helper.
NotificationHelper<ProtocolNotificationContextBase>	getNotificationHelper()
protected abstract NotificationHelper<? extends ProtocolNotificationContextBase>	getNotificationHelperHook()
OnlineReviewsActionHelperBase	getOnlineReviewsActionHelper()
PermissionsHelperBase	getPermissionsHelper() Get the form's PermissionsHelper.
PersonnelHelperBase	getPersonnelHelper()
ProtocolDocumentBase	getProtocolDocument()
ProtocolHelperBase	getProtocolHelper()
String	getQuestionnaireExpression()
String	getQuestionnaireFieldEnd()
String	getQuestionnaireFieldMiddle()
String	getQuestionnaireFieldStarter()
QuestionnaireHelperBase	getQuestionnaireHelper()
ProtocolSpecialReviewHelperBase	getSpecialReviewHelper()
protected abstract List<String>	getTerminalNodeNamesHook()
void	initialize() This method initialize all form variables
boolean	isAuditActivated() Gets whether or not audit has been activated.
boolean	isJavaScriptEnabled()
boolean	isShowNotificationEditor()
boolean	isSuperUserActionAvaliable()
boolean	isSuperUserApproveDocumentAuthorized()
void	populateHeaderFields(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)
void	reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
protected void	setActionHelper(ActionHelperBase actionHelper)
void	setAuditActivated(boolean auditActivated) Sets whether or not audit has been activated.
void	setCustomDataHelper(ProtocolCustomDataHelperBase customDataHelper)
void	setDeletedProtocolFundingSources(List<ProtocolFundingSourceBase> deletedProtocolFundingSources)
void	setDetailId(String detailId)
void	setJavaScriptEnabled(boolean javaScriptEnabled)
void	setLookupResultsBOClassName(String lookupResultsBOClassName)
void	setLookupResultsSequenceNumber(String lookupResultsSequenceNumber)
void	setMedusaBean(MedusaBean medusaBean)
void	setNewProtocolReferenceBean(ProtocolReferenceBeanBase newProtocolReferenceBean)
void	setNotesAttachmentsHelper(NotesAttachmentsHelperBase notesAttachmentsHelper) Sets the Notes & Attachments Helper.
void	setNotificationHelper(NotificationHelper notificationHelper)
void	setOnlineReviewsActionHelper(OnlineReviewsActionHelperBase onlineReviewActionHelper)
void	setProtocolHelper(ProtocolHelperBase protocolHelper)
void	setQuestionnaireHelper(QuestionnaireHelperBase questionnaireHelper)
protected void	setSaveDocumentControl(Map editMode)
void	setShowNotificationEditor(boolean showNotificationEditor)
void	setSpecialReviewHelper(ProtocolSpecialReviewHelperBase specialReviewHelper)

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

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

HIDE_ONLINE_REVIEW_WHEN_DISABLED

protected static final boolean HIDE_ONLINE_REVIEW_WHEN_DISABLED

See Also:

Constant Field Values

ONLINE_REVIEW_NAV_TO

protected static final String ONLINE_REVIEW_NAV_TO

See Also:

Constant Field Values

CUSTOM_DATA_NAV_TO

protected static final String CUSTOM_DATA_NAV_TO

See Also:

Constant Field Values

Constructor Detail

ProtocolFormBase

public ProtocolFormBase()
                 throws Exception

Throws:

Exception

Method Detail

initialize

public void initialize()
                throws Exception

This method initialize all form variables

Throws:

Exception

getNotificationHelperHook

protected abstract NotificationHelper<? extends ProtocolNotificationContextBase> getNotificationHelperHook()

createNewProtocolReferenceBeanInstance

protected abstract ProtocolReferenceBeanBase createNewProtocolReferenceBeanInstance()

createNewQuestionnaireHelperInstanceHook

protected abstract QuestionnaireHelperBase createNewQuestionnaireHelperInstanceHook(ProtocolFormBase protocolForm)

createNewActionHelperInstanceHook

protected abstract ActionHelperBase createNewActionHelperInstanceHook(ProtocolFormBase protocolForm)
                                                               throws Exception

Throws:

Exception

createNewSpecialReviewHelperInstanceHook

protected abstract ProtocolSpecialReviewHelperBase createNewSpecialReviewHelperInstanceHook(ProtocolFormBase protocolForm)

createNewCustomDataHelperInstanceHook

protected abstract ProtocolCustomDataHelperBase createNewCustomDataHelperInstanceHook(ProtocolFormBase protocolForm)

createNewOnlineReviewsActionHelperInstanceHook

protected abstract OnlineReviewsActionHelperBase createNewOnlineReviewsActionHelperInstanceHook(ProtocolFormBase protocolForm)

createNewProtocolHelperInstanceHook

protected abstract ProtocolHelperBase createNewProtocolHelperInstanceHook(ProtocolFormBase protocolForm)

createNewPermissionsHelperInstanceHook

protected abstract PermissionsHelperBase createNewPermissionsHelperInstanceHook(ProtocolFormBase protocolForm)

createNewPersonnelHelperInstanceHook

protected abstract PersonnelHelperBase createNewPersonnelHelperInstanceHook(ProtocolFormBase protocolForm)

createNewQuestionnaireHelper

protected abstract QuestionnaireHelperBase createNewQuestionnaireHelper(ProtocolFormBase protocolForm)

createNewNotesAttachmentsHelperInstanceHook

protected abstract NotesAttachmentsHelperBase createNewNotesAttachmentsHelperInstanceHook(ProtocolFormBase protocolForm)

getDataDictionaryService

protected org.kuali.rice.kns.service.DataDictionaryService getDataDictionaryService()

This method is a wrapper method for getting DataDictionary Service using the Service Locator.

Returns:

populateHeaderFields

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

Overrides:

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

getFormattedDate

protected String getFormattedDate(Date dateInput)

getFormattedDateTime

protected String getFormattedDateTime(Timestamp dateTimeInput)

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

getLookupResultsSequenceNumber

public String getLookupResultsSequenceNumber()

setLookupResultsSequenceNumber

public void setLookupResultsSequenceNumber(String lookupResultsSequenceNumber)

getLookupResultsBOClassName

public String getLookupResultsBOClassName()

setLookupResultsBOClassName

public void setLookupResultsBOClassName(String lookupResultsBOClassName)

setProtocolHelper

public void setProtocolHelper(ProtocolHelperBase protocolHelper)

getProtocolHelper

public ProtocolHelperBase getProtocolHelper()

getPersonnelHelper

public PersonnelHelperBase getPersonnelHelper()

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

setNewProtocolReferenceBean

public void setNewProtocolReferenceBean(ProtocolReferenceBeanBase newProtocolReferenceBean)

getNewProtocolReferenceBean

public ProtocolReferenceBeanBase getNewProtocolReferenceBean()

setSaveDocumentControl

protected void setSaveDocumentControl(Map editMode)

Specified by:

setSaveDocumentControl in class KraTransactionalDocumentFormBase

getCustomDataHelper

public ProtocolCustomDataHelperBase getCustomDataHelper()

Specified by:

getCustomDataHelper in interface CustomDataDocumentForm

setCustomDataHelper

public void setCustomDataHelper(ProtocolCustomDataHelperBase customDataHelper)

isAuditActivated

public boolean isAuditActivated()

Gets whether or not audit has been activated.

Specified by:

isAuditActivated in interface Auditable

Returns:

true if audit is activated false if not.

setAuditActivated

public void setAuditActivated(boolean auditActivated)

Sets whether or not audit has been activated.

Specified by:

setAuditActivated in interface Auditable

Parameters:

auditActivated - true if audit is activated false if not.

getSpecialReviewHelper

public ProtocolSpecialReviewHelperBase getSpecialReviewHelper()

setSpecialReviewHelper

public void setSpecialReviewHelper(ProtocolSpecialReviewHelperBase specialReviewHelper)

getNotesAttachmentsHelper

public NotesAttachmentsHelperBase getNotesAttachmentsHelper()

Gets the Notes & Attachments Helper.

Returns:

Notes & Attachments Helper

setNotesAttachmentsHelper

public void setNotesAttachmentsHelper(NotesAttachmentsHelperBase notesAttachmentsHelper)

Sets the Notes & Attachments Helper.

Parameters:

notesAttachmentsHelper - the Notes & Attachments Helper

getActionHelper

public ActionHelperBase getActionHelper()

setActionHelper

protected void setActionHelper(ActionHelperBase actionHelper)

isJavaScriptEnabled

public boolean isJavaScriptEnabled()

setJavaScriptEnabled

public void setJavaScriptEnabled(boolean javaScriptEnabled)

getProtocolDocument

public ProtocolDocumentBase getProtocolDocument()

getQuestionnaireHelper

public QuestionnaireHelperBase getQuestionnaireHelper()

setQuestionnaireHelper

public void setQuestionnaireHelper(QuestionnaireHelperBase questionnaireHelper)

setOnlineReviewsActionHelper

public void setOnlineReviewsActionHelper(OnlineReviewsActionHelperBase onlineReviewActionHelper)

getOnlineReviewsActionHelper

public OnlineReviewsActionHelperBase getOnlineReviewsActionHelper()

getNotificationHelper

public NotificationHelper<ProtocolNotificationContextBase> getNotificationHelper()

setNotificationHelper

public void setNotificationHelper(NotificationHelper notificationHelper)

getKraAuthorizationService

public KraAuthorizationService getKraAuthorizationService()

getExtraActionsButtons

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

getModuleCode

public abstract String getModuleCode()

Description copied from class: KraTransactionalDocumentFormBase

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

Overrides:

getModuleCode in class KraTransactionalDocumentFormBase

Returns:

getDetailId

public String getDetailId()

setDetailId

public void setDetailId(String detailId)

getDeletedProtocolFundingSources

public List<ProtocolFundingSourceBase> getDeletedProtocolFundingSources()

setDeletedProtocolFundingSources

public void setDeletedProtocolFundingSources(List<ProtocolFundingSourceBase> deletedProtocolFundingSources)

getQuestionnaireFieldStarter

public String getQuestionnaireFieldStarter()

Specified by:

getQuestionnaireFieldStarter in interface QuestionableFormInterface

getQuestionnaireFieldMiddle

public String getQuestionnaireFieldMiddle()

Specified by:

getQuestionnaireFieldMiddle in interface QuestionableFormInterface

getQuestionnaireFieldEnd

public String getQuestionnaireFieldEnd()

Specified by:

getQuestionnaireFieldEnd in interface QuestionableFormInterface

getQuestionnaireExpression

public String getQuestionnaireExpression()

Specified by:

getQuestionnaireExpression in interface QuestionableFormInterface

getMedusaBean

public MedusaBean getMedusaBean()

setMedusaBean

public void setMedusaBean(MedusaBean medusaBean)

getKcPersonService

protected KcPersonService getKcPersonService()

isSuperUserApproveDocumentAuthorized

public boolean isSuperUserApproveDocumentAuthorized()

Overrides:

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

getActionRequests

public List<org.kuali.rice.kew.api.action.ActionRequest> getActionRequests()

Overrides:

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

getTerminalNodeNamesHook

protected abstract List<String> getTerminalNodeNamesHook()

isShowNotificationEditor

public boolean isShowNotificationEditor()

setShowNotificationEditor

public void setShowNotificationEditor(boolean showNotificationEditor)

isSuperUserActionAvaliable

public boolean isSuperUserActionAvaliable()

Overrides:

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