org.kuali.kra.web.struts.action

Class AuditActionHelper

java.lang.Object

org.kuali.kra.web.struts.action.AuditActionHelper

public final class AuditActionHelper
extends Object

Helper class for Audit Actions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuditActionHelper.ValidationState

Constructor Summary

Constructors

Constructor and Description
AuditActionHelper() ctor that sets the used services.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase & Auditable> boolean	auditConditionally(T form) This method will apply audit rules if audit mode is enabled.
boolean	auditUnconditionally(org.kuali.rice.krad.document.Document document) This method will always apply audit rules on a document.
<T extends org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase & Auditable> boolean	auditUnconditionally(T form) This method will apply audit rules disregarding whether audit is enabled.
<T extends org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase & Auditable> AuditActionHelper.ValidationState	isValidSubmission(T form, boolean unconditionally) Runs validation conditionally or otherwise depending on the unconditionally param and then if the validation returns false, checks the audit clusters for any error clusters.
<T extends org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase & Auditable> org.apache.struts.action.ActionForward	setAuditMode(org.apache.struts.action.ActionMapping mapping, T form, boolean audit) This method sets the audit mode on the passed in KualiDocumentFormBase and then returns the correct ActionForward

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditActionHelper

public AuditActionHelper()

ctor that sets the used services.

Method Detail

setAuditMode

public <T extends org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase & Auditable> org.apache.struts.action.ActionForward setAuditMode(org.apache.struts.action.ActionMapping mapping,
                                                                                                                                  T form,
                                                                                                                                  boolean audit)

This method sets the audit mode on the passed in KualiDocumentFormBase and then returns the correct ActionForward

Type Parameters:

T - the action form type

Parameters:

mapping - the action mapping

form - the action form

audit - what to set the audit mode to

Returns:

the action forward

Throws:

NullPointerException - if the mapping or form is null

auditConditionally

public <T extends org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase & Auditable> boolean auditConditionally(T form)

This method will apply audit rules if audit mode is enabled.

Type Parameters:

T - the action form type

Parameters:

form - the action form

Returns:

true if audit passed

Throws:

NullPointerException - if the form is null

auditUnconditionally

public <T extends org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase & Auditable> boolean auditUnconditionally(T form)

This method will apply audit rules disregarding whether audit is enabled.

Type Parameters:

T - the action form type

Parameters:

form - the action form

Returns:

true if audit passed

Throws:

NullPointerException - if the form is null

auditUnconditionally

public boolean auditUnconditionally(org.kuali.rice.krad.document.Document document)

This method will always apply audit rules on a document.

Parameters:

document - the document

Returns:

true if audit passed

Throws:

NullPointerException - if the document is null

isValidSubmission

public <T extends org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase & Auditable> AuditActionHelper.ValidationState isValidSubmission(T form,
                                                                                                                                  boolean unconditionally)

Runs validation conditionally or otherwise depending on the unconditionally param and then if the validation returns false, checks the audit clusters for any error clusters. Then depending returns OK, WARNING or ERROR.

Type Parameters:

T -

Parameters:

form -

unconditionally -

Returns: