org.kuali.kra.rules

Class ErrorReporter

java.lang.Object

org.kuali.kra.rules.ErrorReporter

public class ErrorReporter
extends Object

This class provides error reporting capabilities.

This logic was taken from ResearchDocumentRuleBase so that classes don't have to subclass ResearchDocumentRuleBase to report an error using these convenient methods.

Constructor Summary

Constructors

Constructor and Description
ErrorReporter()

Method Summary

Methods

Modifier and Type	Method and Description
static String	getMethodPath(int fromLevel, int toLevel) This method duplicates the functionality of ExceptionUtils.describeStackLevels which is no longer supported in Rice.
Map<String,Collection<SoftError>>	getSoftErrors()
boolean	propertyHasErrorReported(String propertyName) Does the property have any errors in the message map?
void	removeErrors(String propertyName) Removed the errors in the message map for the property.
void	reportAuditError(org.kuali.rice.kns.util.AuditError error, String errorKey, String clusterLabel, String clusterCategory) Adds an audit error to the KNSGlobalVariables.getAuditErrorMap().
void	reportError(String propertyName, String errorKey, String... errorParams) Wrapper around global errorMap.put call, to allow better logging.
void	reportSoftError(String propertyName, String errorKey, String... errorParams)
void	reportWarning(String propertyName, String errorKey, String... errorParams) Wrapper around global errorMap.put call, to allow better logging.

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorReporter

public ErrorReporter()

Method Detail

reportError

public void reportError(String propertyName,
               String errorKey,
               String... errorParams)

Wrapper around global errorMap.put call, to allow better logging.

Parameters:

propertyName -

errorKey -

errorParams -

reportAuditError

public void reportAuditError(org.kuali.rice.kns.util.AuditError error,
                    String errorKey,
                    String clusterLabel,
                    String clusterCategory)

Adds an audit error to the KNSGlobalVariables.getAuditErrorMap().

Parameters:

error - the error to add.

errorKey - the error map key

clusterLabel - the cluster label

clusterCategory - the cluster category

Throws:

IllegalArgumentException - if error, errorKey, clusterLabel, or clusterCategory are null or if errorKey, clusterLabel, or clusterCategory are whitespace

reportSoftError

public void reportSoftError(String propertyName,
                   String errorKey,
                   String... errorParams)

getSoftErrors

public Map<String,Collection<SoftError>> getSoftErrors()

reportWarning

public void reportWarning(String propertyName,
                 String errorKey,
                 String... errorParams)

Wrapper around global errorMap.put call, to allow better logging.

Parameters:

propertyName -

errorKey -

errorParams -

propertyHasErrorReported

public boolean propertyHasErrorReported(String propertyName)

Does the property have any errors in the message map?

Parameters:

propertyName -

Returns:

removeErrors

public void removeErrors(String propertyName)

Removed the errors in the message map for the property.

Parameters:

propertyName -

getMethodPath

public static String getMethodPath(int fromLevel,
                   int toLevel)

This method duplicates the functionality of ExceptionUtils.describeStackLevels which is no longer supported in Rice.

Parameters:

fromLevel -

toLevel -

Returns: