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

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

All Implemented Interfaces:

Serializable, PojoForm

public class KualiExceptionIncidentForm
extends KualiForm

This class is the action form for all Question Prompts.

See Also:

Serialized Form

Field Summary

private boolean	cancel Flag to determine whether it's cancel action
private String	componentName Form that threw the exception
private String	description Additional message from user
private String	displayMessage The error message to be displayed
private String	documentId Document id.
private String	exceptionMessage The error message
private String	exceptionReportSubject The error subject created from current settings and thrown exception
private static org.apache.log4j.Logger	LOG
private String	principalName Session user name
private static Set<String>	PROPS_NEEDED_FOR_MAP The form properties that should be populated in order for the toMap() method to function properly.
private static long	serialVersionUID
private String	stackTrace Detail message not for displaying
private String	userEmail Session user email address
private String	userName Session user name

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

KualiExceptionIncidentForm()

Method Summary

String	getComponentName()
String	getDescription()
String	getDisplayMessage()
String	getDocumentId()
String	getExceptionMessage()
String	getExceptionReportSubject()
String	getPrincipalName()
String	getStackTrace()
String	getUserEmail()
String	getUserName()
boolean	isCancel()
private boolean	notNull(String s)
void	populate(javax.servlet.http.HttpServletRequest request) Checks for methodToCall parameter, and if not populated in form calls utility method to parse the string from the request.
void	reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request)
void	setCancel(boolean cancel)
void	setComponentName(String componentName)
void	setDescription(String description)
void	setDisplayMessage(String displayMessage)
void	setDocumentId(String documentId)
void	setExceptionMessage(String exceptionMessage)
void	setExceptionReportSubject(String exceptionReportSubject)
void	setPrincipalName(String principalName)
void	setStackTrace(String stackTrace)
void	setUserEmail(String userEmail)
void	setUserName(String userName)
boolean	shouldMethodToCallParameterBeUsed(String methodToCallParameterName, String methodToCallParameterValue, javax.servlet.http.HttpServletRequest request) This overridden method ...
boolean	shouldPropertyBePopulatedInForm(String requestParameterName, javax.servlet.http.HttpServletRequest request) This overridden method ...
Map<String,String>	toMap() This method return list of required information contained by the jsp in both display and hidden properties.

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, populateBackLocation, populateFieldLevelHelpEnabled, reset, retrieveFormValueForLookupInquiryParameters, setActionFormUtilMap, setAnchor, setBackLocation, setCurrentTabIndex, setDerivedValuesOnForm, 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, 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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

LOG

private static org.apache.log4j.Logger LOG

PROPS_NEEDED_FOR_MAP

private static final Set<String> PROPS_NEEDED_FOR_MAP

The form properties that should be populated in order for the toMap() method to function properly.

cancel

private boolean cancel

Flag to determine whether it's cancel action

exceptionReportSubject

private String exceptionReportSubject

The error subject created from current settings and thrown exception

exceptionMessage

private String exceptionMessage

The error message

displayMessage

private String displayMessage

The error message to be displayed

description

private String description

Additional message from user

documentId

private String documentId

Document id. it's blank if not a document process

userEmail

private String userEmail

Session user email address

principalName

private String principalName

Session user name

userName

private String userName

Session user name

stackTrace

private String stackTrace

Detail message not for displaying

componentName

private String componentName

Form that threw the exception

Constructor Detail

KualiExceptionIncidentForm

public KualiExceptionIncidentForm()

Method Detail

populate

public void populate(javax.servlet.http.HttpServletRequest request)

Description copied from class: KualiForm

Checks for methodToCall parameter, and if not populated in form calls utility method to parse the string from the request.

Specified by:

populate in interface PojoForm

Overrides:

populate in class KualiForm

See Also:

org.kuali.rice.krad.web.struts.pojo.PojoForm#populate(javax.servlet.http.HttpServletRequest)

notNull

private boolean notNull(String s)

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.http.HttpServletRequest request)

Overrides:

reset in class KualiForm

See Also:

ActionForm.reset(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)

toMap

public Map<String,String> toMap()

This method return list of required information contained by the jsp in both display and hidden properties.

Returns:

Example: documentId, 2942084 userEmail, someone@somewhere userName, some name componentFormName, Form that threw exception name exceptionMessage, Error message from exception displayMessage, Either exception error message or generic exception error message stackTrace, Exception stack trace here

isCancel

public final boolean isCancel()

Returns:

the cancel

setCancel

public final void setCancel(boolean cancel)

Parameters:

cancel - the cancel to set

getDescription

public final String getDescription()

Returns:

the description

setDescription

public final void setDescription(String description)

Parameters:

description - the description to set

getExceptionMessage

public final String getExceptionMessage()

Returns:

the exceptionMessage

setExceptionMessage

public final void setExceptionMessage(String exceptionMessage)

Parameters:

exceptionMessage - the exceptionMessage to set

getDisplayMessage

public final String getDisplayMessage()

Returns:

the displayMessage

setDisplayMessage

public final void setDisplayMessage(String displayMessage)

Parameters:

displayMessage - the displayMessage to set

getDocumentId

public final String getDocumentId()

Returns:

the documentId

setDocumentId

public final void setDocumentId(String documentId)

Parameters:

documentId - the documentId to set

getUserEmail

public final String getUserEmail()

Returns:

the userEmail

setUserEmail

public final void setUserEmail(String userEmail)

Parameters:

userEmail - the userEmail to set

getPrincipalName

public String getPrincipalName()

Returns:

the principalName

setPrincipalName

public void setPrincipalName(String principalName)

Parameters:

principalName - the principalName to set

getUserName

public final String getUserName()

Returns:

the userName

setUserName

public final void setUserName(String userName)

Parameters:

userName - the userName to set

setStackTrace

public final void setStackTrace(String stackTrace)

Parameters:

stackTrace - the stackTrace to set

getStackTrace

public final String getStackTrace()

Returns:

the stackTrace

getExceptionReportSubject

public final String getExceptionReportSubject()

Returns:

the exceptionReportSubject

setExceptionReportSubject

public final void setExceptionReportSubject(String exceptionReportSubject)

Parameters:

exceptionReportSubject - the exceptionReportSubject to set

getComponentName

public final String getComponentName()

Returns:

the componentName

setComponentName

public final void setComponentName(String componentName)

Parameters:

componentName - the componentName to set

shouldMethodToCallParameterBeUsed

public boolean shouldMethodToCallParameterBeUsed(String methodToCallParameterName,
                                                 String methodToCallParameterValue,
                                                 javax.servlet.http.HttpServletRequest request)

This overridden method ...

Overrides:

shouldMethodToCallParameterBeUsed in class KualiForm

See Also:

org.kuali.rice.krad.web.struts.form.KualiForm#shouldMethodToCallParameterBeUsed(java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest)

shouldPropertyBePopulatedInForm

public boolean shouldPropertyBePopulatedInForm(String requestParameterName,
                                               javax.servlet.http.HttpServletRequest request)

Description copied from class: KualiForm

This overridden method ...

Specified by:

shouldPropertyBePopulatedInForm in interface PojoForm

Overrides:

shouldPropertyBePopulatedInForm in class KualiForm

Parameters:

requestParameterName - the name of the request parameter

request - the HTTP request

Returns:

whether the parameter should be

See Also:

org.kuali.rice.krad.web.struts.form.KualiForm#shouldPropertyBePopulatedInForm(java.lang.String, javax.servlet.http.HttpServletRequest)