org.kuali.kra.protocol.onlinereview

Class ProtocolOnlineReviewFormBase

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.onlinereview.ProtocolOnlineReviewFormBase

All Implemented Interfaces:

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

Direct Known Subclasses:

IacucProtocolOnlineReviewForm, ProtocolOnlineReviewForm

public abstract class ProtocolOnlineReviewFormBase
extends KraTransactionalDocumentFormBase
implements PermissionsForm, Auditable

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

Constructor Summary

Constructors

Constructor and Description
ProtocolOnlineReviewFormBase()

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.
String	getActionName()
abstract boolean	getAdminFieldsEditable()
String	getApproveImageName()
Set<String>	getCurrentRouteNodes()
CustomDataHelperBase	getCustomDataHelper()
protected org.kuali.rice.kns.service.DataDictionaryService	getDataDictionaryService() This method is a wrapper method for getting DataDictionary Service using the Service Locator.
protected abstract String	getDefaultDocumentTypeName()
abstract List<org.kuali.rice.kns.web.ui.ExtraButton>	getExtraActionsButtons()
List<org.kuali.rice.kns.web.ui.ExtraButton>	getExtraButtons()
protected abstract String	getLockRegion()
protected abstract org.apache.commons.logging.Log	getLogHook()
protected abstract Map<String,String>	getOnlineReviewApproveButtonMapHook()
PermissionsHelperBase	getPermissionsHelper() Get the form's PermissionsHelper.
ProtocolOnlineReviewDocumentBase	getProtocolOnlineReviewDocument() Gets a ProtocolDocumentBase.
ResearchDocumentBase	getResearchDocument()
boolean	isAuditActivated() Gets whether or not audit has been activated.
void	populate(javax.servlet.http.HttpServletRequest request)
void	populateHeaderFields(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)
void	reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
void	setAuditActivated(boolean auditActivated) Sets whether or not audit has been activated.
void	setDocument(org.kuali.rice.krad.document.Document document)
protected void	setSaveDocumentControl(Map editMode)

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

clearUnitRulesMessages, getHeaderDispatch, getModuleCode, getNavigateTo, getPersonEditableFields, getSoftErrors, getUnitRulesErrors, getUnitRulesMessages, getUnitRulesMessages, getUnitRulesWarnings, hasModifyBudgetPermission, hasModifyCompletedBudgetPermission, hasModifyNarrativesPermission, hasModifyProposalPermission, isMedusaOpenedDoc, isPopupViewOnly, isUnitRulesErrorsExist, isUnitRulesWarningsExist, isViewOnly, populateFalseCheckboxes, populatePersonEditableFields, processMultiQuestionCheckBox, setActionName, 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, 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

Constructor Detail

ProtocolOnlineReviewFormBase

public ProtocolOnlineReviewFormBase()
                             throws Exception

Throws:

Exception

Method Detail

getProtocolOnlineReviewDocument

public ProtocolOnlineReviewDocumentBase getProtocolOnlineReviewDocument()

Gets a ProtocolDocumentBase.

Returns:

ProtocolDocumentBase

getDefaultDocumentTypeName

protected abstract String getDefaultDocumentTypeName()

Description copied from class: KraTransactionalDocumentFormBase

Specified by:

getDefaultDocumentTypeName in class KraTransactionalDocumentFormBase

setDocument

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

Overrides:

setDocument in class KraTransactionalDocumentFormBase

getDataDictionaryService

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

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

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 org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

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

setSaveDocumentControl

protected void setSaveDocumentControl(Map editMode)

Specified by:

setSaveDocumentControl in class KraTransactionalDocumentFormBase

getLockRegion

protected abstract String getLockRegion()

Specified by:

getLockRegion in class KraTransactionalDocumentFormBase

getActionName

public String getActionName()

Overrides:

getActionName in class KraTransactionalDocumentFormBase

getResearchDocument

public ResearchDocumentBase getResearchDocument()

See Also:

org.kuali.kra.web.struts.form.SpecialReviewFormBase#getResearchDocument()

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

getCustomDataHelper

public CustomDataHelperBase getCustomDataHelper()

isAuditActivated

public boolean isAuditActivated()

Description copied from interface: Auditable

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)

Description copied from interface: Auditable

Sets whether or not audit has been activated.

Specified by:

setAuditActivated in interface Auditable

Parameters:

auditActivated - true if audit is activated false if not.

getExtraActionsButtons

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

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.

Overrides:

addExtraButton in class KraTransactionalDocumentFormBase

Parameters:

property -

source -

altText -

getExtraButtons

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

Overrides:

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

getAdminFieldsEditable

public abstract boolean getAdminFieldsEditable()

getCurrentRouteNodes

public Set<String> getCurrentRouteNodes()

getLogHook

protected abstract org.apache.commons.logging.Log getLogHook()

getApproveImageName

public String getApproveImageName()

getOnlineReviewApproveButtonMapHook

protected abstract Map<String,String> getOnlineReviewApproveButtonMapHook()