org.kuali.rice.kns.web.struts.form
Class KualiHelpForm

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.KualiHelpForm

All Implemented Interfaces:

Serializable, PojoForm

public class KualiHelpForm
extends KualiForm

Holds help parameters and found text.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

KualiForm.TabState

Field Summary

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

KualiHelpForm()

Method Summary

String	getAttributeName()
String	getBusinessObjectClassName()
String	getDocumentTypeName()
String	getHelpDataType() Form field accessor for DataType
HelpDefinition	getHelpDefinition() Form field accessor for system parameter help.
String	getHelpDescription()
String	getHelpLabel()
String	getHelpMaxLength() Form field accessor for Maximum Length
String	getHelpParameterDetailType()
String	getHelpParameterName()
String	getHelpParameterNamespace()
String	getHelpRequired() Form field accessor for Required
String	getHelpSummary()
String	getLookupBusinessObjectClassName()
String	getPageName()
String	getResourceKey()
String	getSearchDocumentTypeName()
String	getValidationPatternName() Form field accessor for name of Validation Pattern
void	setAttributeName(String attributeName)
void	setBusinessObjectClassName(String businessObjectClassName)
void	setDocumentTypeName(String documentTypeName)
void	setHelpDataType(String s) Form field accessor for DataType
void	setHelpDefinition(HelpDefinition helpDefinition) Form field accessor for system parameter help.
void	setHelpDescription(String helpDescription)
void	setHelpLabel(String helpLabel)
void	setHelpMaxLength(String m) Form field accessor for Maximum Length
void	setHelpParameterDetailType(String helpParameterDetailType)
void	setHelpParameterName(String helpParameterName)
void	setHelpParameterNamespace(String helpSecurityGroupName)
void	setHelpRequired(String r) Form field accessor for Required
void	setHelpSummary(String helpSummary)
void	setLookupBusinessObjectClassName(String lookupBusinessObjectClassName)
void	setPageName(String pageName)
void	setResourceKey(String resourceKey)
void	setSearchDocumentTypeName(String searchDocumentTypeName)
void	setValidationPatternName(String v) Form field accessor for name of Validation Pattern

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

addRequiredNonEditableProperties, clearEditablePropertyInformation, getActionFormUtilMap, getAnchor, getBackLocation, getCurrentTabIndex, getDisplayedErrors, getDisplayedInfo, getDisplayedWarnings, getDocInfo, getExtraButton, getExtraButtons, getFieldNameToFocusOnAfterSubmit, getHeaderNavigationTabs, getMethodToCall, getNavigationCss, getNextArbitrarilyHighIndex, getNumColumns, getRefreshCaller, getTabState, getTabStates, incrementTabIndex, isFieldLevelHelpEnabled, populate, populateBackLocation, populateFieldLevelHelpEnabled, reset, reset, retrieveFormValueForLookupInquiryParameters, setActionFormUtilMap, setAnchor, setBackLocation, setCurrentTabIndex, setDerivedValuesOnForm, setDocInfo, setExtraButton, setExtraButtons, setFieldLevelHelpEnabled, setFieldNameToFocusOnAfterSubmit, setHeaderNavigationTabs, setMethodToCall, setNavigationCss, setNumColumns, setRefreshCaller, setTabStates, shouldMethodToCallParameterBeUsed, shouldPropertyBePopulatedInForm

Methods inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, customInitMaxUploadSizes, 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, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KualiHelpForm

public KualiHelpForm()

Method Detail

getAttributeName

public String getAttributeName()

Returns:

Returns the attributeName.

setAttributeName

public void setAttributeName(String attributeName)

Parameters:

attributeName - The attributeName to set.

getBusinessObjectClassName

public String getBusinessObjectClassName()

Returns:

Returns the businessObjectClassName.

setBusinessObjectClassName

public void setBusinessObjectClassName(String businessObjectClassName)

Parameters:

businessObjectClassName - The businessObjectClassName to set.

getHelpDescription

public String getHelpDescription()

Returns:

Returns the helpDescription.

setHelpDescription

public void setHelpDescription(String helpDescription)

Parameters:

helpDescription - The helpDescription to set.

getHelpLabel

public String getHelpLabel()

Returns:

Returns the helpLabel.

setHelpLabel

public void setHelpLabel(String helpLabel)

Parameters:

helpLabel - The helpLabel to set.

getHelpSummary

public String getHelpSummary()

Returns:

Returns the helpSummary.

setHelpSummary

public void setHelpSummary(String helpSummary)

Parameters:

helpSummary - The helpSummary to set.

getResourceKey

public String getResourceKey()

Returns:

Returns the resourceKey.

setResourceKey

public void setResourceKey(String resourceKey)

Parameters:

resourceKey - The resourceKey to set.

getDocumentTypeName

public String getDocumentTypeName()

Returns:

Returns the documentTypeName.

setDocumentTypeName

public void setDocumentTypeName(String documentTypeName)

Parameters:

documentTypeName - The documentTypeName to set.

setHelpRequired

public void setHelpRequired(String r)

Form field accessor for Required

Parameters:

r -

getHelpRequired

public String getHelpRequired()

Form field accessor for Required

Returns:

String

setHelpDataType

public void setHelpDataType(String s)

Form field accessor for DataType

Parameters:

s -

getHelpDataType

public String getHelpDataType()

Form field accessor for DataType

Returns:

String

setHelpMaxLength

public void setHelpMaxLength(String m)

Form field accessor for Maximum Length

Parameters:

m -

getHelpMaxLength

public String getHelpMaxLength()

Form field accessor for Maximum Length

Returns:

String

setValidationPatternName

public void setValidationPatternName(String v)

Form field accessor for name of Validation Pattern

Parameters:

v -

getValidationPatternName

public String getValidationPatternName()

Form field accessor for name of Validation Pattern

Returns:

String

getHelpDefinition

public HelpDefinition getHelpDefinition()

Form field accessor for system parameter help.

Returns:

helpDefinition

setHelpDefinition

public void setHelpDefinition(HelpDefinition helpDefinition)

Form field accessor for system parameter help.

Parameters:

helpDefinition -

getHelpParameterName

public String getHelpParameterName()

setHelpParameterName

public void setHelpParameterName(String helpParameterName)

getHelpParameterNamespace

public String getHelpParameterNamespace()

setHelpParameterNamespace

public void setHelpParameterNamespace(String helpSecurityGroupName)

getPageName

public String getPageName()

setPageName

public void setPageName(String pageName)

getHelpParameterDetailType

public String getHelpParameterDetailType()

setHelpParameterDetailType

public void setHelpParameterDetailType(String helpParameterDetailType)

getLookupBusinessObjectClassName

public String getLookupBusinessObjectClassName()

Returns:

the lookupBusinessObjectClassName

setLookupBusinessObjectClassName

public void setLookupBusinessObjectClassName(String lookupBusinessObjectClassName)

Parameters:

lookupBusinessObjectClassName - the lookupBusinessObjectClassName to set

setSearchDocumentTypeName

public void setSearchDocumentTypeName(String searchDocumentTypeName)

Parameters:

searchDocumentTypeName - the searchDocumentTypeName to set

getSearchDocumentTypeName

public String getSearchDocumentTypeName()

Returns:

the searchDocumentTypeName