org.kuali.kra.negotiations.web.struts.form

Class NegotiationForm

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.negotiations.web.struts.form.NegotiationForm

All Implemented Interfaces:

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

public class NegotiationForm
extends KraTransactionalDocumentFormBase
implements CustomDataDocumentForm

This class holds all the objects required for a negotiation web object.

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

Method Summary

Methods

Modifier and Type	Method and Description
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
CustomDataHelper	getCustomDataHelper()
protected String	getDefaultDocumentTypeName()
boolean	getDispayAssociatedDetailPanel()
boolean	getDispayChangeAssociatedDocumentWarning() This method returns true if the negotiable select icon's need a div tag surrounding it,to generate a javascript warning.
String	getDispayChangeAssociatedDocumentWarningMessage() This method creates creates the opening div tag for the warning javascript message.
boolean	getDisplayAward()
boolean	getDisplayInstitutionalProposal()
boolean	getDisplayProposalLog()
boolean	getDisplaySubAward()
boolean	getDisplayUnAssociatedDetail()
String	getDocumentTypeName() This method returns a string representation of the document type
String	getFilterActivities()
String	getFilterAllActivities()
String	getFilterPendingActivities()
protected String	getLockRegion()
MedusaBean	getMedusaBean()
NegotiationActivityHelper	getNegotiationActivityHelper()
List<NegotiationActivityHistoryLineBean>	getNegotiationActivityHistoryLineBeans() This method calls the negotiation service and return the results of the getNegotiationActivityHistoryLineBeans function.
NegotiationAssociatedDetailBean	getNegotiationAssociatedDetailBean() This method returns the NegotiationAssociatedDetailBean.
NegotiationDocument	getNegotiationDocument()
List<NegotiationNotification>	getNegotiationNotifications() This method calls the negotiation service and return the results of the getNegotiationNotifications function.
NegotiationService	getNegotiationService()
List<NegotiationUnassociatedDetail>	getNegotiationUnassociatedDetailsToDelete()
NotificationHelper<NegotiationCloseNotificationContext>	getNotificationHelper()
String	getStatusRelatedJavascript() This method builds the javascript the disables and enables the ending date field based on the status field.
void	populateHeaderFields(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)
void	setCustomDataHelper(CustomDataHelper customDataHelper) This method sets the custom data helper
void	setFilterActivities(String filterActivities)
void	setMedusaBean(MedusaBean medusaBean)
void	setNegotiationActivityHelper(NegotiationActivityHelper negotiationActivityHelper)
void	setNotificationHelper(NotificationHelper<NegotiationCloseNotificationContext> notificationHelper)
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, 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, 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, reset, 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

Constructor Detail

NegotiationForm

public NegotiationForm()

Constructs a NegotiationForm.java.

Method Detail

getCustomDataHelper

public CustomDataHelper getCustomDataHelper()

Specified by:

getCustomDataHelper in interface CustomDataDocumentForm

See Also:

org.kuali.kra.common.customattributes.CustomDataForm#getCustomDataHelper()

setCustomDataHelper

public void setCustomDataHelper(CustomDataHelper customDataHelper)

This method sets the custom data helper

Parameters:

customDataHelper -

getDocumentTypeName

public String getDocumentTypeName()

This method returns a string representation of the document type

Returns:

getNegotiationDocument

public NegotiationDocument getNegotiationDocument()

getNegotiationUnassociatedDetailsToDelete

public List<NegotiationUnassociatedDetail> getNegotiationUnassociatedDetailsToDelete()

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Description copied from class: KraTransactionalDocumentFormBase

Specified by:

getDefaultDocumentTypeName in class KraTransactionalDocumentFormBase

getLockRegion

protected String getLockRegion()

Specified by:

getLockRegion in class KraTransactionalDocumentFormBase

setSaveDocumentControl

protected void setSaveDocumentControl(Map editMode)

Specified by:

setSaveDocumentControl in class KraTransactionalDocumentFormBase

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

getNegotiationService

public NegotiationService getNegotiationService()

getDisplayUnAssociatedDetail

public boolean getDisplayUnAssociatedDetail()

getDisplayProposalLog

public boolean getDisplayProposalLog()

getDisplayInstitutionalProposal

public boolean getDisplayInstitutionalProposal()

getDisplayAward

public boolean getDisplayAward()

getDisplaySubAward

public boolean getDisplaySubAward()

getNegotiationActivityHelper

public NegotiationActivityHelper getNegotiationActivityHelper()

setNegotiationActivityHelper

public void setNegotiationActivityHelper(NegotiationActivityHelper negotiationActivityHelper)

getDispayAssociatedDetailPanel

public boolean getDispayAssociatedDetailPanel()

populateHeaderFields

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

Overrides:

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

getNegotiationAssociatedDetailBean

public NegotiationAssociatedDetailBean getNegotiationAssociatedDetailBean()

This method returns the NegotiationAssociatedDetailBean. If it hasn't been set, it does so.

Returns:

getStatusRelatedJavascript

public String getStatusRelatedJavascript()

This method builds the javascript the disables and enables the ending date field based on the status field.

Returns:

getMedusaBean

public MedusaBean getMedusaBean()

setMedusaBean

public void setMedusaBean(MedusaBean medusaBean)

getFilterActivities

public String getFilterActivities()

setFilterActivities

public void setFilterActivities(String filterActivities)

getNegotiationActivityHistoryLineBeans

public List<NegotiationActivityHistoryLineBean> getNegotiationActivityHistoryLineBeans()

This method calls the negotiation service and return the results of the getNegotiationActivityHistoryLineBeans function.

Returns:

getNegotiationNotifications

public List<NegotiationNotification> getNegotiationNotifications()

This method calls the negotiation service and return the results of the getNegotiationNotifications function.

Returns:

getNotificationHelper

public NotificationHelper<NegotiationCloseNotificationContext> getNotificationHelper()

setNotificationHelper

public void setNotificationHelper(NotificationHelper<NegotiationCloseNotificationContext> notificationHelper)

getFilterAllActivities

public String getFilterAllActivities()

getFilterPendingActivities

public String getFilterPendingActivities()

getDispayChangeAssociatedDocumentWarning

public boolean getDispayChangeAssociatedDocumentWarning()

This method returns true if the negotiable select icon's need a div tag surrounding it,to generate a javascript warning.

Returns:

getDispayChangeAssociatedDocumentWarningMessage

public String getDispayChangeAssociatedDocumentWarningMessage()

This method creates creates the opening div tag for the warning javascript message.

Returns: